|
4 | 4 | <!-- ALL-CONTRIBUTORS-BADGE:END --> |
5 | 5 | [](https://github.com/EnergySystemsModellingLab/MUSE2/actions/workflows/cargo-test.yml) |
6 | 6 | [](https://codecov.io/github/EnergySystemsModellingLab/MUSE2) |
| 7 | +[](https://crates.io/crates/muse2) |
| 8 | +[](https://doi.org/10.5281/zenodo.17350372) |
7 | 9 | [](https://raw.githubusercontent.com/EnergySystemsModellingLab/MUSE2/main/LICENSE) |
8 | 10 |
|
9 | 11 | # MUSE2 |
@@ -45,11 +47,25 @@ foresight over the whole modelled time horizon. |
45 | 47 |
|
46 | 48 | ## Getting started |
47 | 49 |
|
48 | | -To start using MUSE2, please refer to [the documentation]. If you wish to develop MUSE2 or |
49 | | -build it from source, please see [the developer guide]. |
| 50 | +The easiest way to install MUSE2 is to download the latest version for your platform on [our |
| 51 | +releases page]. For information on getting started, please consult [the documentation]. |
50 | 52 |
|
| 53 | +If you wish to develop MUSE2 or build it from source, please see [the developer guide]. |
| 54 | + |
| 55 | +You can also install the [`muse2` crate from crates.io][muse2-crate], though this installation |
| 56 | +method is only recommended for developers. |
| 57 | + |
| 58 | +[our releases page]: https://github.com/EnergySystemsModellingLab/MUSE2/releases |
51 | 59 | [the documentation]: https://energysystemsmodellinglab.github.io/MUSE2/introduction.html |
52 | 60 | [the developer guide]: https://energysystemsmodellinglab.github.io/MUSE2/developer_guide.html |
| 61 | +[muse2-crate]: https://crates.io/crates/muse2 |
| 62 | + |
| 63 | +## Citing this repository |
| 64 | + |
| 65 | +If you use MUSE2 in your work, please cite us. For information on how to cite this repository, see |
| 66 | +[the Zenodo page for the latest release][zenodo-page]. |
| 67 | + |
| 68 | +[zenodo-page]: https://doi.org/10.5281/zenodo.17350372 |
53 | 69 |
|
54 | 70 | ## Contributors ✨ |
55 | 71 |
|
|
0 commit comments