Tools for MESSAGEix-GLOBIOM models

message_ix_models provides tools for research using the MESSAGEix-GLOBIOM family of models developed by the IIASA Energy, Climate, and Environment (ECE) Program and its collaborators. This ‘family’ includes the ‘main’ or ‘base’ global model and derived models including single-country models and variants with greater sectoral detail. All are built using the MESSAGEix framework and underlying ix modeling platform (ixmp).

Among other tasks, these tools allow modelers to:

  • retrieve input data from various upstream sources,

  • process/transform upstream data into model input parameters,

  • create, populate, modify, and parametrize scenarios,

  • conduct model runs,

  • build model variants with additional details or features, and

  • report quantities computed from model outputs.

User guide

Conceptual documentation

This section contains conceptual and methodological documentation of the ‘base’ or ‘main’ MESSAGEix-GLOBIOM global model, describing in detail how it represents global energy systems:

This is distinct from both the technical documentation in other sections and pages, which describe the code and data used to implement this representation, and the modules for various model ‘variants’ that have similar, yet distinct, structure.

API reference

Commonly used classes may be imported directly from message_ix_models.

message_ix_models.Config(_cache_path, ...)

Core/top-level settings for message_ix_models and message_data.

message_ix_models.Context(*args, **kwargs)

Context and settings for message_ix_models code.

message_ix_models.ScenarioInfo(scenario_obj, ...)

Information about a Scenario object.

message_ix_models.Spec(add, remove, require)

A specification for the structure of a model or variant.

message_ix_models.Workflow(context)

Workflow for operations on multiple Scenarios.

Other submodules are documented on their respective pages:

Note

The documentation for message_data (not public) contains the following pages with information about other projects. No code, data, or documentation for these projects is currently in message_ix_models:

CD-LINKS — COVID-19 — DLE — LEAP-RE — Low-Energy Demand.

Package data

Indices and tables