message_ix_models.model.buildings.Config

class message_ix_models.model.buildings.Config(sturm_scenario: str, climate_scenario: str = 'BL', clone: bool = False, code_dir: ~pathlib.Path = <factory>, max_iterations: int = 0, with_materials: bool = True, _output_path: ~pathlib.Path | None = None, run_access: bool = False, solve: dict[str, ~typing.Any] = <factory>, solve_config: ~message_ix_models.model.workflow.Config = <factory>, ssp: str = 'SSP2', sturm_method: str = 'Rscript')[source]

Bases: object

Configuration options for buildings code.

The code responds to values set on an instance of this class.

Raises:

FileNotFoundError – if code_dir points to a non-existent directory.

__init__(sturm_scenario: str, climate_scenario: str = 'BL', clone: bool = False, code_dir: ~pathlib.Path = <factory>, max_iterations: int = 0, with_materials: bool = True, _output_path: ~pathlib.Path | None = None, run_access: bool = False, solve: dict[str, ~typing.Any] = <factory>, solve_config: ~message_ix_models.model.workflow.Config = <factory>, ssp: str = 'SSP2', sturm_method: str = 'Rscript') None

Methods

__init__(sturm_scenario[, climate_scenario, ...])

set_output_path(context)

Attributes

climate_scenario

Climate scenario.

clone

True if the base scenario should be cloned.

max_iterations

Maximum number of iterations of the ACCESS–STURM–MESSAGE loop.

run_access

Run the ACCESS model on every iteration.

ssp

sturm_method

Method for running STURM.

with_materials

True if the MESSAGEix-Materials + MESSAGEix-Buildings combination is active

sturm_scenario

Name or ID of STURM scenario to run.

code_dir

Path to the MESSAGEix-Buildings code and data.

solve

Keyword arguments for message_ix.Scenario.solve().

solve_config

Similar to solve, but using another config class

climate_scenario: str = 'BL'

Climate scenario. Either BL or 2C.

clone: bool = False

True if the base scenario should be cloned.

code_dir: Path

Path to the MESSAGEix-Buildings code and data.

If not set explicitly, this is populated using _code_dir_factory().

max_iterations: int = 0

Maximum number of iterations of the ACCESS–STURM–MESSAGE loop. Set to 1 for once-through mode.

run_access: bool = False

Run the ACCESS model on every iteration.

solve: dict[str, Any]

Keyword arguments for message_ix.Scenario.solve(). Set model=”MESSAGE_MACRO” to solve scenarios using MESSAGE_MACRO.

solve_config: Config

Similar to solve, but using another config class

ssp: str = 'SSP2'

Todo

Document the meaning of this setting.

sturm_method: str = 'Rscript'

Method for running STURM. See sturm.run().

sturm_scenario: str

Name or ID of STURM scenario to run.

with_materials: bool = True

True if the MESSAGEix-Materials + MESSAGEix-Buildings combination is active