message_ix_models.model.transport.config.CL_SCENARIO

class message_ix_models.model.transport.config.CL_SCENARIO

Bases: StructureFactory[common.Codelist]

SDMX code list IIASA_ECE:CL_SCENARIO_TRANSPORT.

This code list contains unique IDs for scenarios supported by the MESSAGEix-Transport workflow (transport.workflow). Each code has the set of annotations described by ScenarioCodeAnnotations.

__init__()

Methods

__init__()
create()	Create and return the artefact.
get(*[, force])	Retrieve the artefact, possibly from file.
maintainable(_type)	Shorthand to create an empty MaintainableArtefact.

Attributes

base_url	Base scenario URL, including model name and scenario name.
urn	Partial URN for the artefact that is returned, excluding the version.
version	Version.

base_url = 'ixmp://ixmp-dev/SSP_SSP{}_v6.5/baseline_DEFAULT_step_13'

Base scenario URL, including model name and scenario name.

• Model name:

  • 2024-11-25: use _v1.1 per a Microsoft Teams message.

  • 2025-02-20: update to _v2.1 per discussion with OF. At this point _v2.3 is the latest appearing in the database.

  • 2025-05-05: update to _v5.0.

  • 2025-06-24: update to _v6.1.

  • 2026-04-07: update to _v6.5. See also _append_code() for a special override.

• The scenario names appear to form a sequence from “baseline_DEFAULT” to “baseline_DEFAULT_step_15” and finally “baseline”. The one used below is the latest in this sequence for which y₀=2020, rather than 2030.

classmethod create() → common.Codelist

Create and return the artefact.

classmethod get(*, force: bool = False) → MaintainableT

Retrieve the artefact, possibly from file.

The highest version of the artefact with urn is loaded using from file using read().

If the artefact from file has a version that does not match version or if force=True, create() is called to regenerate a complete and up-to-date version of the artefact as of version. This updated version is stored using write().

classmethod maintainable(_type: type[MaintainableT]) → MaintainableT

Shorthand to create an empty MaintainableArtefact.

• urn is parsed for a maintainer and artefact ID.

• version is used.

• A new instance of _type is created and returned.

urn: str = 'IIASA_ECE:CL_SCENARIO_TRANSPORT'

Partial URN for the artefact that is returned, excluding the version.

version: str = '1.5.0'

Version.