Configuration

General configuration

There is one general configuration file per material model (plastics, steel, cement) where users can adjust the settings for each run of the respective model, such as which plots to create, or choosing between different modelling parameters. The following table lists the settings that can be adjusted with their type, default values and description:

Parameter	Type	Default	Description
model	ModelNames		Model to use. Must be one of 'plastics', 'steel', or 'cement'.
input	InputCfg		Input data configuration.
input.madrat_output_path	str		Where to find the madrat output archives to extract input data from.
input.force_extract_tgz	bool		Whether to force re-extraction of input data from tgz files. If False, extraction is only performed if pre-extracted data is not up-to date.
input.input_data_path	str		Path to the input data directory.
input.scenarios_path	str		Path to the scenario definition directory.
input.input_data_version	str		Version of the input data to use
model_switches	ModelSwitches		Model customization parameters.
model_switches.scenario	str		Name of the scenario to use.
model_switches.stock_extrapolation_class_name	str		Class name of the extrapolation subclass to use for stock extrapolation.
model_switches.lifetime_model_name	str		Class name of the lifetime model subclass to use for the in-use stock.
model_switches.do_stock_extrapolation_by_category	bool	False	Whether to perform stock extrapolation by good category.
model_switches.regress_over	RegressOverModes		Variable to use as a predictor for stock extrapolation.
model_switches.parameter_extrapolation	Optional		Mapping of parameter names to extrapolation subclass names for parameter extrapolation from historical values into the future.
visualization	VisualizationCfg		Visualization configuration.
visualization.do_visualize	bool	True	Whether to create visualizations for this entity
visualization.figures_path	str		Path to the figures directory.
visualization.do_show_figs	bool	True	Whether to show figures.
visualization.do_save_figs	bool	False	Whether to save figures.
visualization.plotting_engine	str	plotly	Plotting engine to use for visualizations.
visualization.plotly_renderer	str	browser	Plotly renderer to use for visualizations.
visualization.use_stock	StockVisualizationCfg		Visualization configuration for use stock.
visualization.use_stock.do_visualize	bool	True	Whether to create visualizations for this entity
visualization.use_stock.per_capita	bool	False	Whether to visualize stock per capita.
visualization.use_stock.over_gdp	bool	False	Whether to visualize stock over GDPpC. Alternative is over time
visualization.use_stock.accumulate_gdp	bool	False	Whether to accumulate GDPpC over time (i.e. do not allow decreasing GDPpC) for visualization purposes.
visualization.production	BaseVisualizationCfg		Visualization configuration for production.
visualization.production.do_visualize	bool	True	Whether to create visualizations for this entity
visualization.sankey	SankeyVisualizationCfg		Visualization configuration for sankey.
visualization.sankey.do_visualize	bool	True	Whether to create visualizations for this entity
visualization.sankey.plotter_args	dict	{}	dictionary of arguments to pass to the Sankey plotter
visualization.extrapolation	BaseVisualizationCfg		Visualization configuration for extrapolation.
visualization.extrapolation.do_visualize	bool	True	Whether to create visualizations for this entity
export	ExportCfg		Data export configuration.
export.do_export	bool	True	Whether to export this entity
export.path	str		Path to export folder for this entity
export.csv	BaseExportCfg		Configuration of export to CSV files
export.csv.do_export	bool	True	Whether to export this entity
export.csv.path	str		Path to export folder for this entity
export.pickle	BaseExportCfg		Configuration of export to pickle files.
export.pickle.do_export	bool	True	Whether to export this entity
export.pickle.path	str		Path to export folder for this entity
export.assumptions	BaseExportCfg		Configuration of export of assumptions to a txt file.
export.assumptions.do_export	bool	True	Whether to export this entity
export.assumptions.path	str		Path to export folder for this entity
export.docs	BaseExportCfg		Configuration of export to documentation files.
export.docs.do_export	bool	True	Whether to export this entity
export.docs.path	str		Path to export folder for this entity
export.iamc	BaseExportCfg		Configuration of export of results in IAMC format.
export.iamc.do_export	bool	True	Whether to export this entity
export.iamc.path	str		Path to export folder for this entity

Scenario configuration

The config folder contains a "scenarios" folder with configuration files that define parameter settings for different scenarios: The implemented scenario variation framework enables simple variation of input parameters. For each material model (plastics, steel, cement), a set of scenario parameters is defined in material_definition.py, that can be adjusted through the scenario configuration files in YAML format. A scenario is defined as a set of input parameters that deviate from the parameters of the baseline or parent scenario. This means that scenarios can inherit from existing ones. For instance, the scenario "SSP1" inherits from its parent scenario "SSP2", i.e. all parameter values defined in SSP2 are adopted in SSP1 unless they are overwritten in the configuration file for SSP1.