Skip to content

Commit 7045d20

Browse files
committed
user_guide.md: Add section about building models
1 parent 81cafb8 commit 7045d20

1 file changed

Lines changed: 65 additions & 3 deletions

File tree

docs/user_guide.md

Lines changed: 65 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,75 @@ You can run examples like so:
3434
muse2 example run simple
3535
```
3636

37-
To see the input files for an example (e.g. to use as a template for your own model), run:
37+
[example models]: ./examples.md
38+
39+
## Building and running your own model
40+
41+
> 🚧 Note that this section is under construction! 🚧
42+
>
43+
> In the longer term, we [plan to have a tutorial][tutorial-issue] describing how to build a model
44+
> in more detail.
45+
46+
Models in MUSE2 are defined with one [TOML] file (`model.toml`) and many CSV files. For a
47+
description of each of the files and the different fields, see [the documentation for input files].
48+
49+
[TOML]: https://toml.io/en/
50+
[input-files-docs]: file_formats/input_files.md
51+
52+
### Creating a new model from an example
53+
54+
We recommend you use one of the examples as starting point for your own model, as there are many
55+
required files.
56+
57+
To create a new model based on the `simple` example, run:
3858

3959
```sh
40-
muse2 example extract simple
60+
muse2 example extract simple new_model
4161
```
4262

43-
[example models]: ./examples.md
63+
This will create a new subdirectory called `new_model` in the current folder.
64+
65+
### Running this model
66+
67+
First, let's run this model so you can see the output for a working model. You can do this by
68+
running:
69+
70+
```sh
71+
muse2 run new_model
72+
```
73+
74+
If everything works as expected, you should see output on your terminal indicating the progress of
75+
the simulation (which should finish very quickly).
76+
77+
The first few lines should look something like:
78+
79+
```txt
80+
[12:24:20 INFO muse2::cli] Starting MUSE2 v2.0.0
81+
[12:24:20 INFO muse2::cli] Loaded model from new_model/
82+
[12:24:20 INFO muse2::cli] Output folder: muse2_results/new_model
83+
...
84+
```
85+
86+
You should see that a new `muse2_results` folder has been created. This folder will contain the
87+
output for your model in a subfolder called `new_model`. For information about how to interpret
88+
these files, see [the documentation for output files]. We also have some [example Jupyter
89+
notebooks].
90+
91+
[example Jupyter notebooks]: https://github.com/EnergySystemsModellingLab/MUSE2/tree/main/docs/notebooks
92+
93+
### Next steps
94+
95+
You will now want to configure the model for your own use case. You should start by looking at [the
96+
documentation for the input files][input-files-docs] for details of the different data types and
97+
parameters for MUSE2.
98+
99+
Unfortunately, this may not be easy, especially if you are not already familiar with [MUSE1]. In the
100+
longer term, [we will have tutorials][tutorial-issue], so watch this space! In the meantime, if you
101+
have a question, feel free to [open an issue].
102+
103+
[MUSE1]: https://github.com/EnergySystemsModellingLab/MUSE_OS
104+
[tutorial-issue]: https://github.com/EnergySystemsModellingLab/MUSE2/issues/921
105+
[open an issue]: https://github.com/EnergySystemsModellingLab/MUSE2/issues
44106

45107
## Visualising commodity graphs
46108

0 commit comments

Comments
 (0)