Skip to content

Move funder acknowledgements from CITATION.cff to README.md #1253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexdewar merged 3 commits into from
Apr 23, 2026
Merged

Move funder acknowledgements from CITATION.cff to README.md #1253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfdb37b
Include overview snippet from `README.md` in `docs/README.md` cf. cop…
alexdewar Apr 16, 2026
cff506a
CITATION.cff: Fix typo
alexdewar Apr 16, 2026
fde0a06
Move funder acknowledgements from `CITATION.cff` to `README.md`
alexdewar Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
cff-version: 1.2.0
message: |
If you cite this software, please cite it as below.

This work was supported via the Climate Compatible Growth (CCG) programme and the EPSRC-funded
HI-ACT project (EP/X038823/2). CCG is funded by UK Aid from the UK government. However, the views
expressed herein do not necessarily reflect the UK government's official policies.
message: If you use this software, please cite it as below.
title: MUSE2
version: 2.1.0
date-released: 2026-03-31
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
> :warning: **Please note that MUSE2 currently only works with simple models and is not yet suitable
for use in research.** :warning:

<!-- ANCHOR: overview -->
MUSE2 (**M**od**U**lar energy systems **S**imulation **E**nvironment) is a tool for running
simulations of energy systems, written in Rust. Its purpose is to provide users with a framework to
simulate pathways of energy system transition, usually in the context of climate change mitigation.
Expand All @@ -23,7 +24,14 @@ It is the successor to [MUSE], which is written in Python. It was developed foll
MUSE to address a range of legacy issues that are challenging to address via upgrades to the
existing MUSE framework, and to implement the framework in the high-performance Rust language.

This work was supported via the Climate Compatible Growth (CCG) programme and the EPSRC-funded
HI-ACT project ([EP/X038823/2][HI-ACT grant]). CCG is funded by UK Aid from the UK government.
However, the views expressed herein do not necessarily reflect the UK government's official
policies.

[HI-ACT grant]: https://gtr.ukri.org/projects?ref=EP%2FX038823%2F2
[MUSE]: https://github.com/EnergySystemsModellingLab/MUSE_OS
<!-- ANCHOR_END: overview -->

## Getting started

Expand Down
10 changes: 1 addition & 9 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,7 @@
> ⚠️ **Please note that MUSE2 currently only works with simple models and is not yet suitable
for use in research.** ⚠️

MUSE2 (**M**od**U**lar energy systems **S**imulation **E**nvironment) is a tool for running
simulations of energy systems, written in Rust. Its purpose is to provide users with a framework to
simulate pathways of energy system transition, usually in the context of climate change mitigation.

It is the successor to [MUSE], which is written in Python. It was developed following re-design of
MUSE to address a range of legacy issues that are challenging to address via upgrades to the
existing MUSE framework, and to implement the framework in the high-performance Rust language.

[MUSE]: https://github.com/EnergySystemsModellingLab/MUSE_OS
{{#include ../README.md:overview}}

## Getting started

Expand Down
Loading