-
Notifications
You must be signed in to change notification settings - Fork 1
Improve README pages #1074
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.
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
Open
alexdewar
wants to merge
3
commits into
main
Choose a base branch
from
improve-readmes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Improve README pages #1074
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,42 @@ | ||
| # Introduction | ||
| # MUSE2 | ||
|
|
||
| MUSE2 is a tool for running simulations of energy systems, written in Rust. It is a slimmer and | ||
| faster version of [the older MUSE tool]. To get started, please look at the [user guide] | ||
| and the [command line help]. | ||
| ## Overview | ||
|
|
||
| For an overview of the model, see the [model description] and the [dispatch optimisation | ||
| formulation]. For a list of relevant terms, see the [glossary]. | ||
| > ⚠️ **Please note that MUSE2 currently only works with simple models and is not yet suitable | ||
| for use in research.** ⚠️ | ||
|
|
||
| If you are a developer, please see the [developer guide]. | ||
| 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. | ||
|
|
||
| [the older MUSE tool]: https://github.com/EnergySystemsModellingLab/MUSE_OS | ||
| 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 | ||
|
|
||
| ## Getting started | ||
|
|
||
| You will first need to install MUSE2. We recommend downloading the latest version for your platform | ||
| on [the releases page]. The archive file you download should contain a readme file containing | ||
| instructions on how to run MUSE2. Alternatively, you can install the [`muse2` crate from | ||
| crates.io][muse2-crate] using [`cargo`] (see [Setting up your development environment][dev-setup]). | ||
|
|
||
| Once you have installed MUSE2, you can look at the [user guide] and the [command line help] for | ||
| details on how to get started with creating and running your own models. | ||
|
|
||
| Detailed information about the model used by MUSE2 is provided in [Model Description]. For a list of | ||
| relevant terms, see the [glossary]. | ||
|
|
||
| If you want to work with the MUSE2 source code, for instance to submit a change to this repository, | ||
| please see the [developer guide]. | ||
|
|
||
| [the releases page]: https://github.com/EnergySystemsModellingLab/MUSE2/releases | ||
| [`cargo`]: https://doc.rust-lang.org/cargo/ | ||
| [dev-setup]: ./developer_guide/setup.md | ||
| [muse2-crate]: https://crates.io/crates/muse2 | ||
| [user guide]: ./user_guide.md | ||
| [command line help]: ./command_line_help.md | ||
| [model description]: ./model/ | ||
| [dispatch optimisation formulation]: ./model/dispatch_optimisation.md | ||
| [Model Description]: ./model/ | ||
| [glossary]: ./glossary.md | ||
| [developer guide]: ./developer_guide/ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.