Merge pull request #896 from EnergySystemsModellingLab/rename-to-muse2

Rename from MUSE 2.0 to MUSE2 everywhere

Author: alexdewar

.all-contributorsrc

@@ -1,5 +1,5 @@
 {
-  "projectName": "MUSE_2.0",
+  "projectName": "MUSE2",
   "projectOwner": "EnergySystemsModellingLab",
   "repoType": "github",
   "repoHost": "https://github.com",

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
 {
-    "name": "MUSE 2.0",
+    "name": "MUSE2",
     "build": {
         "context": "..",
         "dockerfile": "../Dockerfile"

.lycheeignore

@@ -1,5 +1,5 @@
 # For some reason these spurious links appear in some cargo doc-generated files
-^file://.+/MUSE_2.0/book/api/index\.html$
+^file://.+/MUSE2/book/api/index\.html$
 
 # Times out on GitHub runner
 ^http://www.adobe.com

CONTRIBUTING.md

@@ -44,7 +44,7 @@ This section guides you through submitting a bug report for MUSE. Following thes
 maintainers and the community understand your report :pencil:, reproduce the behavior :computer:
 :computer:, and find related reports :mag_right:.
 
-Before creating bug reports, please check [this list](https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues)
+Before creating bug reports, please check [this list](https://github.com/EnergySystemsModellingLab/MUSE2/issues)
 (including the closed issues) as you might find out that you don't need to create one. When you are
 creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).
 
@@ -73,7 +73,7 @@ Provide more context by answering these questions:
   this always a problem?
 - If the problem started happening recently, **can you reproduce the problem in an older version of
   MUSE?** What's the most recent version in which the problem doesn't happen? You can download older
-  versions of MUSE from [the releases page](https://github.com/EnergySystemsModellingLab/MUSE_2.0/releases).
+  versions of MUSE from [the releases page](https://github.com/EnergySystemsModellingLab/MUSE2/releases).
 - **Can you reliably reproduce the issue?** If not, provide details about how often the problem
   happens and under which conditions it normally happens.
 
@@ -90,7 +90,7 @@ This section guides you through submitting an enhancement suggestion for MUSE, i
 new features and minor improvements to existing functionality. Following these guidelines helps
 maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
 
-Before creating enhancement suggestions, please check [this list](https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues)
+Before creating enhancement suggestions, please check [this list](https://github.com/EnergySystemsModellingLab/MUSE2/issues)
 (including closed issues) as you might find out that you don't need to create one. When you are
 creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion).
 
@@ -112,10 +112,10 @@ Create an issue on that repository and provide the following information:
 Unsure where to begin contributing to MUSE? You can start by looking through these `beginner` and
 `help-wanted` issues:
 
-- [Beginner issues](https://github.com/EnergySystemsModellingLab/MUSE_2.0/labels/good%20first%20issue),
+- [Beginner issues](https://github.com/EnergySystemsModellingLab/MUSE2/labels/good%20first%20issue),
   issues which should only require a few lines
   of code, and a test or two.
-- [Help wanted issues](https://github.com/EnergySystemsModellingLab/MUSE_2.0/labels/help%20wanted),
+- [Help wanted issues](https://github.com/EnergySystemsModellingLab/MUSE2/labels/help%20wanted),
   issues which should be a bit more involved than `beginner` issues.
 
 ### Pull Requests

Cargo.toml

@@ -4,9 +4,9 @@ version = "2.0.0-dev1"
 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"
-documentation = "https://energysystemsmodellinglab.github.io/MUSE_2.0"
+documentation = "https://energysystemsmodellinglab.github.io/MUSE2"
 readme = "README.md"
-repository = "https://github.com/EnergySystemsModellingLab/MUSE_2.0"
+repository = "https://github.com/EnergySystemsModellingLab/MUSE2"
 license = "GPL-3.0-only"
 keywords = ["energy", "modelling"]
 categories = ["science", "simulation", "command-line-utilities"]

README.md

@@ -2,13 +2,13 @@
 <!-- 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-BADGE:END -->
-[![Build and test](https://github.com/EnergySystemsModellingLab/MUSE_2.0/actions/workflows/cargo-test.yml/badge.svg)](https://github.com/EnergySystemsModellingLab/MUSE_2.0/actions/workflows/cargo-test.yml)
-[![codecov](https://codecov.io/github/EnergySystemsModellingLab/MUSE_2.0/graph/badge.svg?token=nV8gp1NCh8)](https://codecov.io/github/EnergySystemsModellingLab/MUSE_2.0)
-[![GitHub](https://img.shields.io/github/license/EnergySystemsModellingLab/MUSE_2.0)](https://raw.githubusercontent.com/EnergySystemsModellingLab/MUSE_2.0/main/LICENSE)
+[![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)
+[![GitHub](https://img.shields.io/github/license/EnergySystemsModellingLab/MUSE2)](https://raw.githubusercontent.com/EnergySystemsModellingLab/MUSE2/main/LICENSE)
 
-# MUSE 2.0
+# MUSE2
 
-MUSE 2.0 (**M**od**U**lar energy systems **S**imulation **E**nvironment) is a tool for running
+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.
 
@@ -41,11 +41,11 @@ foresight over the whole modelled time horizon.
 
 ## Getting started
 
-To start using MUSE 2.0, please refer to [the documentation]. If you wish to develop MUSE 2.0 or
+To start using MUSE2, please refer to [the documentation]. If you wish to develop MUSE2 or
 build it from source, please see [the developer guide].
 
-[the documentation]: https://energysystemsmodellinglab.github.io/MUSE_2.0/introduction.html
-[the developer guide]: https://energysystemsmodellinglab.github.io/MUSE_2.0/developer_guide.html
+[the documentation]: https://energysystemsmodellinglab.github.io/MUSE2/introduction.html
+[the developer guide]: https://energysystemsmodellinglab.github.io/MUSE2/developer_guide.html
 
 ## Contributors ✨
 
@@ -57,17 +57,17 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <table>
   <tbody>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/"><img src="https://avatars.githubusercontent.com/u/23149834?v=4?s=100" width="100px;" alt="Alex Dewar"/><br /><sub><b>Alex Dewar</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=alexdewar" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tsmbland"><img src="https://avatars.githubusercontent.com/u/23723407?v=4?s=100" width="100px;" alt="Tom Bland"/><br /><sub><b>Tom Bland</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=tsmbland" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Sahil590"><img src="https://avatars.githubusercontent.com/u/56438860?v=4?s=100" width="100px;" alt="Sahil Raja"/><br /><sub><b>Sahil Raja</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=Sahil590" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ashmit8583"><img src="https://avatars.githubusercontent.com/u/137117727?v=4?s=100" width="100px;" alt="Ashmit Sikdar"/><br /><sub><b>Ashmit Sikdar</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=Ashmit8583" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/"><img src="https://avatars.githubusercontent.com/u/6095790?v=4?s=100" width="100px;" alt="Diego Alonso Álvarez"/><br /><sub><b>Diego Alonso Álvarez</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=dalonsoa" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AdrianDAlessandro"><img src="https://avatars.githubusercontent.com/u/40875798?v=4?s=100" width="100px;" alt="Adrian D'Alessandro"/><br /><sub><b>Adrian D'Alessandro</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=AdrianDAlessandro" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/TinyMarsh"><img src="https://avatars.githubusercontent.com/u/13540127?v=4?s=100" width="100px;" alt="Ryan Smith"/><br /><sub><b>Ryan Smith</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE_2.0/commits?author=TinyMarsh" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/"><img src="https://avatars.githubusercontent.com/u/23149834?v=4?s=100" width="100px;" alt="Alex Dewar"/><br /><sub><b>Alex Dewar</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=alexdewar" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tsmbland"><img src="https://avatars.githubusercontent.com/u/23723407?v=4?s=100" width="100px;" alt="Tom Bland"/><br /><sub><b>Tom Bland</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=tsmbland" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Sahil590"><img src="https://avatars.githubusercontent.com/u/56438860?v=4?s=100" width="100px;" alt="Sahil Raja"/><br /><sub><b>Sahil Raja</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=Sahil590" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ashmit8583"><img src="https://avatars.githubusercontent.com/u/137117727?v=4?s=100" width="100px;" alt="Ashmit Sikdar"/><br /><sub><b>Ashmit Sikdar</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=Ashmit8583" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/"><img src="https://avatars.githubusercontent.com/u/6095790?v=4?s=100" width="100px;" alt="Diego Alonso Álvarez"/><br /><sub><b>Diego Alonso Álvarez</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=dalonsoa" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AdrianDAlessandro"><img src="https://avatars.githubusercontent.com/u/40875798?v=4?s=100" width="100px;" alt="Adrian D'Alessandro"/><br /><sub><b>Adrian D'Alessandro</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=AdrianDAlessandro" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/TinyMarsh"><img src="https://avatars.githubusercontent.com/u/13540127?v=4?s=100" width="100px;" alt="Ryan Smith"/><br /><sub><b>Ryan Smith</b></sub></a><br /><a href="https://github.com/EnergySystemsModellingLab/MUSE2/commits?author=TinyMarsh" title="Code">💻</a></td>
     </tr>
     <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/MUSE_2.0/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/MUSE_2.0/commits?author=ahawkes" title="Documentation">📖</a></td>
+      <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>
     </tr>
   </tbody>
   <tfoot>

assets/readme/README.md

@@ -1,3 +1,3 @@
-# Readme files for MUSE 2.0
+# Readme files for MUSE2
 
-This folder contains readme files to be included with MUSE 2.0 releases.
+This folder contains readme files to be included with MUSE2 releases.

assets/readme/readme_linux.txt

@@ -1,16 +1,16 @@
-This folder contains the MUSE 2.0 executable for Linux, called `muse2`.
+This folder contains the MUSE2 executable for Linux, called `muse2`.
 
 The only pre-requisite is libstdc++.so, which is likely installed on your system already. If not,
 you can install with your package manager, e.g. for Ubuntu:
 
     sudo apt install libstdc++6
 
-For more information on how to use MUSE 2.0, you can consult the program help:
+For more information on how to use MUSE2, you can consult the program help:
 
     ./muse2 help
 
 Documentation is also available on the web:
-    https://energysystemsmodellinglab.github.io/MUSE_2.0/
+    https://energysystemsmodellinglab.github.io/MUSE2/
 
 Please report bugs on our GitHub issue tracker:
-    https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues
+    https://github.com/EnergySystemsModellingLab/MUSE2/issues

assets/readme/readme_macos_arm.txt

@@ -1,17 +1,17 @@
-This folder contains the MUSE 2.0 executable for macOS (Apple Silicon), called `muse2`.
+This folder contains the MUSE2 executable for macOS (Apple Silicon), called `muse2`.
 
 When trying to run the `muse2` program, you may see an error message saying "muse2 can't be opened
 because Apple cannot check it for malicious software." To fix this, you should open `muse2` by
 right-clicking on it in your file explorer and clicking "Open". You will be prompted to give
 permission for the program to run. Once you have completed this step, you should be able to run the
 program as normal.
 
-For more information on how to use MUSE 2.0, you can consult the program help:
+For more information on how to use MUSE2, you can consult the program help:
 
     ./muse2 help
 
 Documentation is also available on the web:
-    https://energysystemsmodellinglab.github.io/MUSE_2.0/
+    https://energysystemsmodellinglab.github.io/MUSE2/
 
 Please report bugs on our GitHub issue tracker:
-    https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues
+    https://github.com/EnergySystemsModellingLab/MUSE2/issues

assets/readme/readme_windows.txt

@@ -1,11 +1,11 @@
-This folder contains the MUSE 2.0 executable for Windows, called `muse2`.
+This folder contains the MUSE2 executable for Windows, called `muse2`.
 
-For more information on how to use MUSE 2.0, you can consult the program help:
+For more information on how to use MUSE2, you can consult the program help:
 
     ./muse2 help
 
 Documentation is also available on the web:
-    https://energysystemsmodellinglab.github.io/MUSE_2.0/
+    https://energysystemsmodellinglab.github.io/MUSE2/
 
 Please report bugs on our GitHub issue tracker:
-    https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues
+    https://github.com/EnergySystemsModellingLab/MUSE2/issues