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.
True
if the base scenario should be cloned.Maximum number of iterations of the ACCESS–STURM–MESSAGE loop.
Run the ACCESS model on every iteration.
Method for running STURM.
True
if the MESSAGEix-Materials + MESSAGEix-Buildings combination is activeName or ID of STURM scenario to run.
Path to the MESSAGEix-Buildings code and data.
Keyword arguments for
message_ix.Scenario.solve()
.Similar to solve, but using another config class
- 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.
- solve: dict[str, Any]
Keyword arguments for
message_ix.Scenario.solve()
. Set model=”MESSAGE_MACRO” to solve scenarios using MESSAGE_MACRO.
- sturm_method: str = 'Rscript'
Method for running STURM. See
sturm.run()
.