EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE2

Add tutorial for building new model

Open
#921 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Rust
Stars
8
Forks
5
Avg merge
1d 2m
Merged PRs (30d)
37

Description

The [current documentation](https://energysystemsmodellinglab.github.io/MUSE2/user_guide.html) is a little sparse and it would be difficult for someone who'd never encountered MUSE1 to figure out how to build their own model.

MUSE1 has [great documentation](https://muse-os.readthedocs.io/en/latest/), including very thorough [tutorials](https://muse-os.readthedocs.io/en/latest/user-guide/index.html). It would be great if we could have something similar for MUSE2.

One approach would be to literally port one or more of the tutorials from MUSE1 to MUSE2. Note that this may not be trivial given the differences between MUSE1 and MUSE2 (and may not be possible in some cases, if the relevant features are not available in MUSE2), but it may be a good starting point.

If anyone takes this, they should ask @tsmbland about it first.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.