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 single-country and other models derived from the main, global model; all built in the MESSAGEix framework and on the ix modeling platform (ixmp).

Among other tasks, the 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,

• set up model variants with additional details or features, and

• report quantities computed from model outputs.

User guide

• Installation
• Data, metadata, and configuration
• Command-line interface
• Reproducibility
• Distributed computing
• References

API reference

• Models and variants (model)
  • Config
  • model.structure: Model structure information
• Reproduce the RES (model.bare)
  • Configuration
  • Code reference
• Building models (model.build)
  • Code reference
• Emissions data (model.emissions)
  • add_tax_emission()
• Consumer disutility
  • Method & usage
  • Detailed example
  • Code reference
• Specific research projects (project)
• General purpose modeling tools
  • ADVANCE data
• Low-level utilities (util)
  • Adapter
  • MappingAdapter
  • add_par_data()
  • aggregate_codes()
  • as_codes()
  • broadcast()
  • cached()
  • check_support()
  • convert_units()
  • copy_column()
  • eval_anno()
  • ffill()
  • identify_nodes()
  • iter_parameters()
  • load_package_data()
  • load_private_data()
  • local_data_path()
  • make_io()
  • make_matched_dfs()
  • make_source_tech()
  • maybe_query()
  • merge_data()
  • package_data_path()
  • private_data_path()
  • replace_par_data()
  • same_node()
  • same_time()
  • series_of_pint_quantity()
  • strip_par_data()
  • SKIP_CACHE
  • util.click
  • util.config
  • util.context
  • util.importlib
  • util._logging
  • util.node
  • util.scenarioinfo
• Test utilities and fixtures (testing)
  • CliRunner
  • EXPORT_OMIT
  • NIE
  • bare_res()
  • export_test_data()
  • mix_models_cli()
  • not_ci()
  • pytest_addoption()
  • session_context()
  • test_context()
  • user_context()
• Multi-scenario workflows (workflow)
  • Concept & design
  • Usage
  • API reference

Variants and projects

• MESSAGEix-Nexus (model.water)
  • CLI usage
  • Code reference
  • Data, metadata, and config files
  • Pre-processing
  • Deprecated R Code
  • Reference

Package data

• Node code lists
  • Models with global scope
  • Others
• Relations (relation/*.yaml)
  • List A
  • List B
  • List CD-LINKS
• Years or time periods (year/*.yaml)
  • List A
  • List B
• Other code lists
  • Commodities (commodity.yaml)
  • Levels (level.yaml)
  • Technologies (technology.yaml)
• IIASA Scenario Explorer metadata
  • mappings-R12.yaml
  • def-regions.yaml

Development

• Development practices
  • Advertise and check compatibility
• What’s new
  • v2023.5.13 (2023-05-13)
  • 2023.4.2
  • 2023.2.8
  • 2022.11.7
  • 2022.8.17
  • 2022.7.25
  • 2022.5.6
  • 2022.3.30
  • 2022.3.3
  • 2022.1.26
  • Earlier releases
• Migrating from message_data
• Releasing
  • Version numbers
  • Procedure

Indices and tables

• Index

• Module Index

• Search Page