diff --git a/CITATION.cff b/CITATION.cff index 9ad8734b..9e0d5348 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -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 diff --git a/README.md b/README.md index 95f4c3f0..eb2c87c3 100644 --- a/README.md +++ b/README.md @@ -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: + 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. @@ -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 + ## Getting started diff --git a/docs/README.md b/docs/README.md index 77f8ea8a..c857a43c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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