User Guide
Running MUSE2
Once you have installed MUSE2, you should be able to run it via the muse2 command-line program.
For details of the command-line interface, see here.
Visualising commodity graphs
To visualise the structure of your model, you can use the the muse2 save-graphs command to
create graphs of commodity/process relationships.
This command will output a graph for each region/year in the simulation, where nodes are commodities
and edges are processes.
Graphs will be saved in DOT format, which can be visualised locally with Graphviz, or online
with Graphviz online.
Modifying the program settings
You can configure the behaviour of MUSE2 with a settings.toml file. To edit this file, run:
muse2 settings edit
There are also some more commands for working with the settings file; for details, run: muse2 settings help.
For information about the available settings, see the documentation for the settings.toml
file.
Setting the log level
MUSE uses the fern crate for logging. The default log level is info, though this can be
configured either via the log_level option in settings.toml or by setting the
MUSE2_LOG_LEVEL environment variable. (If both are used, the environment variable takes
precedence.)
The possible options are:
errorwarninfodebugtraceoff
By default, MUSE will colourise the log output if this is available (i.e. it is outputting to a terminal rather than a file).
For more information, please consult the fern documentation.