Skip to content

Commit a2c9613

Browse files
committed
Add user guide
1 parent 1f79d06 commit a2c9613

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/user_guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@
55
Once you have installed MUSE2, you should be able to run it via the `muse2` command-line program.
66
For details of the command-line interface, [see here](./command_line_help.md).
77

8+
### Visualising commodity graphs
9+
10+
To visualise the structure of your model, you can use the [the `muse2 save-graphs` command] to
11+
create graphs of commodity/process relationships.
12+
This command will output a graph for each region/year in the simulation, where nodes are commodities
13+
and edges are processes.
14+
Graphs will be saved in [DOT format], which can be visualised locally with [Graphviz], or online
15+
with [Graphviz online].
16+
17+
[the `muse2 save-graphs` command]: https://energysystemsmodellinglab.github.io/MUSE2/command_line_help.html#muse2-save-graphs
18+
[DOT format]: https://graphviz.org/doc/info/lang.html
19+
[Graphviz]: https://graphviz.org/
20+
[Graphviz online]: https://dreampuf.github.io/GraphvizOnline
21+
822
## Modifying the program settings
923

1024
You can configure the behaviour of MUSE2 with a `settings.toml` file. To edit this file, run:

0 commit comments

Comments
 (0)