Tools for MESSAGEix-GLOBIOM models
**********************************

:mod:`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 <#index-conceptual>`_
and derived models including single-country models and `variants with greater sectoral detail <#index-variant>`_.
All are built using the `MESSAGEix framework <https://docs.messageix.org>`_
and underlying `ix modeling platform (ixmp) <https://docs.messageix.org/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.

.. toctree::
   :maxdepth: 1
   :caption: User guide

   install
   data
   cli
   howto/index
   repro
   distrib
   develop
   whatsnew
   bibliography

.. _index-conceptual:

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:

.. toctree::
   :maxdepth: 2
   :caption: Conceptual documentation
   :hidden:

   global/index

- :doc:`global/index`

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’ <#index-variants>`_ that have similar, yet distinct, structure.

API reference
=============

.. currentmodule:: message_ix_models

Commonly used classes may be imported directly from :mod:`message_ix_models`.

.. autosummary::

   message_ix_models.Config
   message_ix_models.Context
   message_ix_models.ScenarioInfo
   message_ix_models.Spec
   message_ix_models.Workflow

Other submodules are documented on their respective pages:

- :doc:`api/model`
- :doc:`api/model-bare`
- :doc:`api/model-build`
- :doc:`api/model-emissions`
- :doc:`api/model-snapshot`
- :doc:`api/model-workflow`
- :doc:`api/disutility`
- :doc:`api/report/index`
- :doc:`api/tools`
- :doc:`api/data-sources`
- :doc:`api/workflow`
- :doc:`api/util`
- :doc:`api/testing`
- :doc:`api/tests`

.. toctree::
   :maxdepth: 2
   :caption: API reference
   :hidden:

   api/model
   api/model-bare
   api/model-build
   api/model-emissions
   api/model-snapshot
   api/model-workflow
   api/disutility
   api/report/index
   api/tools
   api/tools-costs
   api/tools-messagev
   api/data-sources
   api/workflow
   api/util
   api/testing
   api/tests

.. _index-variants:

.. toctree::
   :maxdepth: 1
   :caption: Model variants

   buildings/index
   material/index
   transport/index
   water/index

.. _index-projects:

.. toctree::
   :maxdepth: 1
   :caption: Research projects

   project/advance
   project/alps
   project/carbon-direct
   project/cfr
   project/circeular
   project/digsy
   project/ecemf
   project/edits
   project/efc
   project/elevate
   project/engage
   project/gea
   project/geidco
   project/genie
   project/guide
   project/hyway
   project/navigate
   project/newpathways
   project/nextgen-carbon
   project/ngfs
   project/prisma
   project/scenariomip
   project/shape
   project/sparccle
   project/spipa
   project/ssp
   project/uptake

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

   :doc:`m-data:reference/projects/cd_links` —
   :doc:`COVID-19 <m-data:reference/projects/covid>` —
   :doc:`m-data:project/dle` —
   :doc:`m-data:project/leap_re` —
   :doc:`m-data:reference/projects/led`.

.. toctree::
   :maxdepth: 1
   :caption: Package data

   pkg-data/node
   pkg-data/relation
   pkg-data/year
   pkg-data/codelists
   pkg-data/iiasa-se

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`