message_ix_models.tools.inter_pipe.Config

class message_ix_models.tools.inter_pipe.Config(first_model_year: int, pipe: message_ix_models.tools.inter_pipe.TechConfig, supply: message_ix_models.tools.inter_pipe.TechConfig, scenario: message_ix_models.tools.inter_pipe.ScenarioConfig, spec: message_ix_models.tools.inter_pipe.SpecConfig)

Bases: object

__init__(first_model_year: int, pipe: TechConfig, supply: TechConfig, scenario: ScenarioConfig, spec: SpecConfig) → None

Methods

__init__(first_model_year, pipe, supply, ...)
from_file([path])	Read configuration from file.

Attributes

first_model_year	TODO Document what this means, in contrast to \(y_0\) of the scenario itself.
pipe	The pipe technology is the technology that is used to transport the commodity from one node to another.
supply	The pipe supply technology is the technology that feed commodity to the pipe technology.
scenario
spec

first_model_year: int

TODO Document what this means, in contrast to \(y_0\) of the scenario itself.

classmethod from_file(path: Path | str | None = None) → Config

Read configuration from file.

Some notes about the file format:

• Two top-level keys called pipe_tech and pipe_supplytech contain keys that have the same structure and names, except for different suffixes. For example, tech_mother_shorten_pipe appears under pipe_tech; tech_mother_shorten_supply appears under pipe_supplytech. This function strips the suffixes so both can be stored as instances of TechConfig.

pipe: TechConfig

The pipe technology is the technology that is used to transport the commodity from one node to another.

supply: TechConfig

The pipe supply technology is the technology that feed commodity to the pipe technology.