From dfdb37b2097dc0658b5ebba55ef02e4a3ff62156 Mon Sep 17 00:00:00 2001 From: Alex Dewar Date: Thu, 16 Apr 2026 17:38:52 +0100 Subject: [PATCH 1/3] Include overview snippet from `README.md` in `docs/README.md` cf. copy-pasting --- README.md | 2 ++ docs/README.md | 10 +--------- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 95f4c3f00..ccd8f575f 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. @@ -24,6 +25,7 @@ MUSE to address a range of legacy issues that are challenging to address via upg existing MUSE framework, and to implement the framework in the high-performance Rust language. [MUSE]: https://github.com/EnergySystemsModellingLab/MUSE_OS + ## Getting started diff --git a/docs/README.md b/docs/README.md index 77f8ea8a3..c857a43c9 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 From cff506a8c59c2a49c09c9fef6b43ced5ea9f3d8e Mon Sep 17 00:00:00 2001 From: Alex Dewar Date: Thu, 16 Apr 2026 17:27:50 +0100 Subject: [PATCH 2/3] CITATION.cff: Fix typo --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 9ad8734bb..70452052e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,6 +1,6 @@ cff-version: 1.2.0 message: | - If you cite this software, please cite it as below. + If you use 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 From fde0a06ab0e09363acf0ec9caa3b0085aac56989 Mon Sep 17 00:00:00 2001 From: Alex Dewar Date: Thu, 16 Apr 2026 17:32:33 +0100 Subject: [PATCH 3/3] Move funder acknowledgements from `CITATION.cff` to `README.md` --- CITATION.cff | 7 +------ README.md | 6 ++++++ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 70452052e..9e0d53485 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,10 +1,5 @@ cff-version: 1.2.0 -message: | - If you use 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 ccd8f575f..eb2c87c35 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,12 @@ 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