Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

    docs: ▲

    Command-Line Help for muse2

    This document contains the help content for the muse2 command-line program.

    Command Overview:

    muse2

    A tool for running simulations of energy systems

    Usage: muse2 [COMMAND]

    Subcommands:
    • run — Run a simulation model
    • example — Manage example models
    • validate — Validate a model
    • save-graphs — Build and output commodity flow graphs for a model
    • settings — Manage settings file

    muse2 run

    Run a simulation model

    Usage: muse2 run [OPTIONS] <MODEL_DIR>

    Arguments:
    • <MODEL_DIR> — Path to the model directory
    Options:
    • -o, --output-dir <OUTPUT_DIR> — Directory for output files
    • --overwrite — Whether to overwrite the output directory if it already exists
    • --debug-model — Whether to write additional information to CSV files

    muse2 example

    Manage example models

    Usage: muse2 example <COMMAND>

    Subcommands:
    • list — List available examples
    • info — Provide information about the specified example
    • extract — Extract an example model configuration to a new directory
    • run — Run an example

    muse2 example list

    List available examples

    Usage: muse2 example list

    muse2 example info

    Provide information about the specified example

    Usage: muse2 example info <NAME>

    Arguments:
    • <NAME> — The name of the example

    muse2 example extract

    Extract an example model configuration to a new directory

    Usage: muse2 example extract <NAME> [NEW_PATH]

    Arguments:
    • <NAME> — The name of the example to extract
    • <NEW_PATH> — The destination folder for the example

    muse2 example run

    Run an example

    Usage: muse2 example run [OPTIONS] <NAME>

    Arguments:
    • <NAME> — The name of the example to run
    Options:
    • -o, --output-dir <OUTPUT_DIR> — Directory for output files
    • --overwrite — Whether to overwrite the output directory if it already exists
    • --debug-model — Whether to write additional information to CSV files

    muse2 validate

    Validate a model

    Usage: muse2 validate <MODEL_DIR>

    Arguments:
    • <MODEL_DIR> — The path to the model directory

    muse2 save-graphs

    Build and output commodity flow graphs for a model

    Usage: muse2 save-graphs [OPTIONS] <MODEL_DIR>

    Arguments:
    • <MODEL_DIR> — The path to the model directory
    Options:
    • -o, --output-dir <OUTPUT_DIR> — Directory for graph files
    • --overwrite — Whether to overwrite the output directory if it already exists

    muse2 settings

    Manage settings file

    Usage: muse2 settings <COMMAND>

    Subcommands:
    • edit — Edit the program settings file
    • delete — Delete the settings file, if any
    • path — Get the path to where the settings file is read from
    • show — Show the contents of the settings.toml, if present
    • show-default — Show the default settings for settings.toml

    muse2 settings edit

    Edit the program settings file

    Usage: muse2 settings edit

    muse2 settings delete

    Delete the settings file, if any

    Usage: muse2 settings delete

    muse2 settings path

    Get the path to where the settings file is read from

    Usage: muse2 settings path

    muse2 settings show

    Show the contents of the settings.toml, if present

    Usage: muse2 settings show

    muse2 settings show-default

    Show the default settings for settings.toml

    Usage: muse2 settings show-default

    This document was generated automatically by clap-markdown.