Merge pull request #917 from EnergySystemsModellingLab/make-v2.0.0-release

alexdewar · web-flow · commit d544d65145a2 · 2025-10-14T13:58:01.000+01:00
Add `CITATION.cff` and prepare for v2.0.0 release
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -91,6 +91,15 @@
         "ideas",
         "doc"
       ]
+    },
+    {
+      "login": "Aurashk",
+      "name": "Aurash Karimi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9390150?v=4",
+      "profile": "https://github.com/Aurashk",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -69,3 +69,7 @@ repos:
       - id: codespell
         args: [--ignore-words, .codespell_ignore.txt]
         exclude: \.svg$
+  - repo: https://github.com/citation-file-format/cffconvert
+    rev: b6045d78aac9e02b039703b030588d54d53262ac
+    hooks:
+      - id: validate-cff
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,37 @@
+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.
+title: MUSE2
+version: 2.0.0
+date-released: 2025-10-13
+authors:
+  - family-names: Dewar
+    given-names: Alex
+    orcid: https://orcid.org/0000-0002-2432-5964
+  - family-names: Bland
+    given-names: Tom
+    orcid: https://orcid.org/0000-0001-6677-8817
+  - family-names: Raja
+    given-names: Sahil
+  - family-names: Alonso Álvarez
+    given-names: Diego
+    orcid: https://orcid.org/0000-0002-0060-9495
+  - family-names: D'Alessandro
+    given-names: Adrian
+    orcid: https://orcid.org/0009-0002-9503-5777
+  - family-names: Smith
+    given-names: Ryan
+    orcid: https://orcid.org/0009-0007-7270-6853
+  - family-names: Scharpf
+    given-names: Benjamin
+  - family-names: Karimi
+    given-names: Aurash
+  - family-names: Hawkes
+    given-names: Adam
+    orcid: https://orcid.org/0000-0001-9720-332X
+license: GPL-3.0-only
+repository-code: https://github.com/EnergySystemsModellingLab/MUSE2
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "muse2"
-version = "2.0.0-dev1"
+version = "2.0.0"
 authors = ["Hawkes Research Group @ Chemical Engineering, Imperial College London <a.hawkes@imperial.ac.uk>", "Imperial College London RSE Team <ict-rse-team@imperial.ac.uk>"]
 edition = "2024"
 description = "A tool for running simulations of energy systems"
@@ -41,6 +41,7 @@ edit = "0.1.5"
 [dev-dependencies]
 map-macro = "0.3.0"
 rstest = {version = "0.26.1", default-features = false, features = ["crate-name"]}
+yaml-rust2 = {version = "0.10.4", default-features = false}
 
 [build-dependencies]
 built = {version = "0.8.0", features = ["chrono", "git2"]}
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <!-- markdownlint-disable MD041 -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![Build and test](https://github.com/EnergySystemsModellingLab/MUSE2/actions/workflows/cargo-test.yml/badge.svg)](https://github.com/EnergySystemsModellingLab/MUSE2/actions/workflows/cargo-test.yml)
 [![codecov](https://codecov.io/github/EnergySystemsModellingLab/MUSE2/graph/badge.svg?token=nV8gp1NCh8)](https://codecov.io/github/EnergySystemsModellingLab/MUSE2)
@@ -16,8 +16,13 @@ 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.
 
-:construction: **Please note that this code is under heavy development and is not yet suitable for
-end users. Watch this space!** :construction:
+Please note that MUSE2 currently only works with simple models and is not yet suitable for use in
+research.
+
+To download the latest version of MUSE2 for your platform, please visit [the releases page].
+
+[MUSE]: https://github.com/EnergySystemsModellingLab/MUSE_OS
+[the releases page]: https://github.com/EnergySystemsModellingLab/MUSE2/releases
 
 ## Model Overview
 
@@ -34,7 +39,6 @@ foresight, reacting only to information available in the current time period. Th
 intertemporal optimisation modelling frameworks (such as [TIMES] and [MESSAGEix]) which have perfect
 foresight over the whole modelled time horizon.
 
-[MUSE]: https://github.com/EnergySystemsModellingLab/MUSE_OS
 [Integrated Assessment Modelling]: https://unfccc.int/topics/mitigation/workstreams/response-measures/modelling-tools-to-assess-the-impact-of-the-implementation-of-response-measures/integrated-assessment-models-iams-and-energy-environment-economy-e3-models
 [TIMES]: https://iea-etsap.org/index.php/etsap-tools/model-generators/times
 [MESSAGEix]: https://docs.messageix.org/en/latest
@@ -68,6 +72,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/HarmonicReflux"><img src="https://avatars.githubusercontent.com/u/16504600?v=4?s=100" width="100px;" alt="Benjamin Scharpf"/><br /><sub><b>Benjamin Scharpf</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=HarmonicReflux" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ahawkes"><img src="https://avatars.githubusercontent.com/u/12055725?v=4?s=100" width="100px;" alt="Adam Hawkes"/><br /><sub><b>Adam Hawkes</b></sub></a><br /><a href="#ideas-ahawkes" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=ahawkes" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Aurashk"><img src="https://avatars.githubusercontent.com/u/9390150?v=4?s=100" width="100px;" alt="Aurash Karimi"/><br /><sub><b>Aurash Karimi</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=Aurashk" title="Code">💻</a></td>
     </tr>
   </tbody>
   <tfoot>
diff --git a/src/cli.rs b/src/cli.rs
@@ -115,14 +115,14 @@ pub fn run_cli() -> Result<()> {
         return Ok(());
     }
 
-    let Some(command) = cli.command else {
-        // Output program help in markdown format
-        let help_str = Cli::command().render_long_help().to_string();
-        println!("{help_str}");
-        return Ok(());
-    };
+    if let Some(command) = cli.command {
+        command.execute()?;
+    } else {
+        // No command provided. Show help.
+        Cli::command().print_long_help()?;
+    }
 
-    command.execute()
+    Ok(())
 }
 
 /// Handle the `run` command.
@@ -166,6 +166,8 @@ pub fn handle_run_command(
     // Initialise program logger
     log::init(&settings.log_level, Some(output_path)).context("Failed to initialise logging.")?;
 
+    info!("Starting MUSE2 v{}", env!("CARGO_PKG_VERSION"));
+
     // Load the model to run
     let (model, assets) = load_model(model_path).context("Failed to load model.")?;
     info!("Loaded model from {}", model_path.display());
diff --git a/src/cli/example.rs b/src/cli/example.rs
@@ -71,7 +71,7 @@ fn handle_example_info_command(name: &str) -> Result<()> {
         .contents_utf8()
         .expect("README.txt is not UTF-8 encoded");
 
-    println!("{readme}");
+    print!("{readme}");
 
     Ok(())
 }
diff --git a/tests/citation_cff.rs b/tests/citation_cff.rs
@@ -0,0 +1,32 @@
+//! Check the CITATION.cff file
+use anyhow::{Context, Result};
+use std::fs;
+use yaml_rust2::{Yaml, YamlLoader};
+
+fn get_version_from_citation_cff() -> Result<String> {
+    let citation = fs::read_to_string("CITATION.cff")?;
+    let yaml = YamlLoader::load_from_str(&citation)?;
+    let yaml = yaml
+        .iter()
+        .next()
+        .context("Empty YAML file")?
+        .as_hash()
+        .context("Not YAML object")?;
+    let version = yaml
+        .get(&Yaml::from_str("version"))
+        .context("version key not found")?
+        .as_str()
+        .context("version should be string")?;
+
+    Ok(version.to_string())
+}
+
+#[test]
+fn test_citation_cff_version() {
+    assert_eq!(
+        env!("CARGO_PKG_VERSION"),
+        get_version_from_citation_cff().unwrap(),
+        "Software version in Cargo.toml and CITATION.cff must match. If you are making a new \
+        release, please also update the CITATION.cff file."
+    )
+}

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ fn handle_example_info_command(name: &str) -> Result<()> {`
`71`	`71`	`.contents_utf8()`
`72`	`72`	`.expect("README.txt is not UTF-8 encoded");`
`73`	`73`
`74`		`- println!("{readme}");`
	`74`	`+ print!("{readme}");`
`75`	`75`
`76`	`76`	`Ok(())`
`77`	`77`	`}`