message_ix_models.model.transport.config.ScenarioCodeAnnotations

class message_ix_models.model.transport.config.ScenarioCodeAnnotations(SSP_URN: str, is_LED_scenario: bool, DIGSY_scenario_URN: str, EDITS_scenario_URN: str, base_scenario_URL: str, policy: Policy | None, extra_modules: list[str] = <factory>)[source]

Bases: AnnotationsMixIn

Set of annotations appearing on each Code in CL_TRANSPORT_SCENARIO.

See Config.code.

__init__(SSP_URN: str, is_LED_scenario: bool, DIGSY_scenario_URN: str, EDITS_scenario_URN: str, base_scenario_URL: str, policy: Policy | None, extra_modules: list[str] = <factory>) → None

Methods

`__init__`(SSP_URN, is_LED_scenario, ...[, ...])
`from_obj`(obj[, globals])	Return a new instance of cls given an AnnotableArtefact obj.
`get_annotations`(_rtype)	Return a collection of `Annotation` for the fields of the object.

Attributes

`SSP_URN`	The URN of a code identifying the SSP scenario to be used for sociodemographic data, for instance "urn:sdmx:org.sdmx.infomodel.codelist.Code=ICONICS:SSP(2024).1".
`is_LED_scenario`	`True` if the scenario is a "Low Energy Demand" scenario.
`DIGSY_scenario_URN`	URN of a code from `digsy.structure.SCENARIO`.
`EDITS_scenario_URN`	URN of a code from `edits.structure.SCENARIO`.
`base_scenario_URL`	`ixmp` URL of a base scenario on which the MESSAGEix-Transport scenario is to be built.
`policy`	Entries for `Config.policy`.
`extra_modules`	Entries for `Config.extra_modules`.

DIGSY_scenario_URN: str: URN of a code from digsy.structure.SCENARIO.

EDITS_scenario_URN: str: URN of a code from edits.structure.SCENARIO.

SSP_URN: str: The URN of a code identifying the SSP scenario to be used for sociodemographic data, for instance “urn:sdmx:org.sdmx.infomodel.codelist.Code=ICONICS:SSP(2024).1”.

base_scenario_URL: str: ixmp URL of a base scenario on which the MESSAGEix-Transport scenario is to be built.

extra_modules: list[str]: Entries for Config.extra_modules.

classmethod from_obj(obj, globals=None)[source]: Return a new instance of cls given an AnnotableArtefact obj.

get_annotations(_rtype: type[list] | type[dict])

Return a collection of Annotation for the fields of the object.

Returns:

list of Annotation – if _rtype is list.
dict – if _rtype is dict. The dict has the one key “annotations”, mapped to a list of Annotations. This can be used as a keyword argument to the constructor of a AnnotableArtefact subclass.

is_LED_scenario: bool: True if the scenario is a “Low Energy Demand” scenario.

policy: Policy | None: Entries for Config.policy.