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: ▲

    Output Files

    This file contains information about the file formats for MUSE2 output files.

    Note that we only document the main CSV output files, not those produced when the --debug-model option is active.

    Metadata: metadata.toml

    Metadata about the program run, the MUSE2 build and the user’s platform.

    Top-level table

    FieldDescriptionNotes
    runInformation about the program run
    programInformation about MUSE2
    platformInformation about the platform on which the simulation was run

    [run] table

    FieldDescriptionNotes
    model_pathPath to the input model
    datetimeTimestamp for the model runTime at which the model run commenced

    [program] table

    FieldDescriptionNotes
    nameThe name of the program (muse2)
    versionProgram version (e.g. 2.0.0)
    targetThe target triple MUSE2 was built for
    is_debugWhether the current build is a debug or release build
    rustc_versionThe version of rustc used to compile MUSE2
    build_time_utcThe UTC time and date at which MUSE2 was built
    git_commit_hashThe short hash of the git commit from which MUSE2 was builtIf the git working tree was dirty, -dirty is appended to the hash

    [platform] table

    FieldDescriptionNotes
    sysnameThe name of the implementation of the operating system
    nodenameThe hostname of the machine
    releaseThe release level of the operating system
    versionThe version level of the release
    machineThe name of the system’s hardware
    osnameThe name of the current OS

    Main CSV output files

    assets.csv

    Assets commissioned during the course of the simulation.

    FieldDescriptionNotes
    asset_idThe ID number of this asset
    process_idThe ID of this asset’s associated process
    region_idThe region in which this asset exists
    agent_idThe agent to which this asset belongs
    commission_yearThe year in which the asset was commissioned

    asset_capacities.csv

    Capacity of each asset at each milestone year during the simulation.

    FieldDescriptionNotes
    milestone_yearThe milestone year of the simulation
    asset_idThe ID of this asset
    capacityThe total capacity of the asset in this yearFor divisible assets, this is the total capacity across all units.
    num_unitsThe number of active units making up the asset in this yearFor non-divisible assets, this is always blank.

    commodity_flows.csv

    How much of each commodity was produced and consumed in the course of the simulation.

    FieldDescriptionNotes
    milestone_yearMilestone year of the simulation
    asset_idThe asset this entry relates toSee the assets.csv output file for information about assets
    commodity_idThe commodity this entry relates to
    time_sliceThe time slice during which this flow occurred
    flowThe amount of commodity flowIf the commodity was produced, this value will be positive and if it was consumed, it will be negative.

    commodity_prices.csv

    The prices of commodities over time and place.

    FieldDescriptionNotes
    milestone_yearMilestone year of the simulation
    commodity_idThe commodity this entry relates to
    region_idThe region this entry relates to
    time_sliceThe time slice in which this price holds
    priceThe price of the commodity