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.

Field	Description	Notes
`run`	Information about the program run
`program`	Information about MUSE2
`platform`	Information about the platform on which the simulation was run

Field	Description	Notes
`model_path`	Path to the input model
`datetime`	Timestamp for the model run	Time at which the model run commenced

Field	Description	Notes
`name`	The name of the program (`muse2`)
`version`	Program version (e.g. 2.0.0)
`target`	The target triple MUSE2 was built for
`is_debug`	Whether the current build is a debug or release build
`rustc_version`	The version of `rustc` used to compile MUSE2
`build_time_utc`	The UTC time and date at which MUSE2 was built
`git_commit_hash`	The short hash of the git commit from which MUSE2 was built	If the git working tree was dirty, `-dirty` is appended to the hash

Field	Description	Notes
`sysname`	The name of the implementation of the operating system
`nodename`	The hostname of the machine
`release`	The release level of the operating system
`version`	The version level of the release
`machine`	The name of the system’s hardware
`osname`	The name of the current OS

Assets commissioned during the course of the simulation.

Field	Description	Notes
`asset_id`	The ID number of this asset	Every commissioned non-divisible asset in the system is automatically assigned a numerical ID. This includes assets supplied by the user in the `assets.csv` input file as well as those selected by agents during the simulation. For divisible assets, this field will be empty and `group_id` will be filled instead.
`group_id`	The group ID number of this asset, if any	Numerical identifier used for divisible assets.
`process_id`	The ID of this asset’s associated process
`region_id`	The region in which this asset exists
`agent_id`	The agent to which this asset belongs
`commission_year`	The year in which the asset was commissioned

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

Field	Description	Notes
`milestone_year`	The milestone year of the simulation
`asset_id`	The ID of this asset	Filled for non-divisible assets. Empty for divisible assets, which use `group_id` instead. See the `assets.csv` output file for further information about assets.
`group_id`	The group ID of this asset group	Filled for divisible assets. Empty for non-divisible assets, which use `asset_id` instead. See the `assets.csv` output file for further information about groups.
`capacity`	The total capacity of the asset in this year	For divisible assets, this is the total capacity across all active child assets (i.e. unit size multiplied by the number of active units).
`num_units`	The number of active units making up the asset in this year	For non-divisible assets, this is always blank.

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

Field	Description	Notes
`milestone_year`	Milestone year of the simulation
`asset_id`	The asset this entry relates to	See the `assets.csv` output file for information about assets
`commodity_id`	The commodity this entry relates to
`time_slice`	The time slice during which this flow occurred
`flow`	The amount of commodity flow	If the commodity was produced, this value will be positive and if it was consumed, it will be negative.

The prices of commodities over time and place.

Field	Description	Notes
`milestone_year`	Milestone year of the simulation
`commodity_id`	The commodity this entry relates to
`region_id`	The region this entry relates to
`time_slice`	The time slice in which this price holds
`price`	The price of the commodity