File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11# User Guide
22
3- ## Running MUSE2
4-
53Once you have installed MUSE2, you should be able to run it via the ` muse2 ` command-line program.
6- For details of the command-line interface, [ see here] ( ./command_line_help.md ) .
4+ For details of the command-line interface, [ see here] ( ./command_line_help.md ) or run ` muse2 help ` .
5+
6+ ## Example models
7+
8+ MUSE2 comes with a number of [ example models] , partly to demonstrate the various program features as
9+ well as to be used as templates for new models. To see the list of available examples, you can run:
10+
11+ ``` sh
12+ muse2 example list
13+ ```
14+
15+ It should print something like the following:
16+
17+ ``` sh
18+ missing_commodity
19+ muse1_default
20+ simple
21+ two_outputs
22+ two_regions
23+ ```
24+
25+ To view information about a particular example, you can run, e.g.:
26+
27+ ``` sh
28+ muse2 example info simple
29+ ```
30+
31+ You can run examples like so:
32+
33+ ``` sh
34+ muse2 example run simple
35+ ```
36+
37+ To see the input files for an example (e.g. to use as a template for your own model), run:
38+
39+ ``` sh
40+ muse2 example extract simple
41+ ```
42+
43+ [ example models ] : ./examples.md
744
8- ### Visualising commodity graphs
45+ ## Visualising commodity graphs
946
1047To visualise the structure of your model, you can use the [ the ` muse2 save-graphs ` command] to
1148create graphs of commodity/process relationships.
You can’t perform that action at this time.
0 commit comments