Skip to content

Commit 6233186

Browse files
committed
Move doc/global/index to a new toctree section
1 parent ed1d61e commit 6233186

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

doc/index.rst

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
Tools for MESSAGEix-GLOBIOM models
22
**********************************
33

4-
: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.
5-
This ‘family’ includes single-country and other models derived from the main, global model; all built in the `MESSAGEix framework <https://docs.messageix.org>`_ and on the `ix modeling platform (ixmp) <https://docs.messageix.org/ixmp/>`_.
4+
:mod:`message_ix_models` provides tools for research using the **MESSAGEix-GLOBIOM family of models**
5+
developed by the IIASA Energy, Climate, and Environment (ECE) Program and its collaborators.
6+
This ‘family’ includes the `‘main’ or ‘base’ global model <#index-conceptual>`_
7+
and derived models including single-country models and `variants with greater sectoral detail <#index-variant>`_.
8+
All are built using the `MESSAGEix framework <https://docs.messageix.org>`_
9+
and underlying `ix modeling platform (ixmp) <https://docs.messageix.org/ixmp/>`_.
610

711
Among other tasks, the tools allow modelers to:
812

@@ -27,6 +31,29 @@ Among other tasks, the tools allow modelers to:
2731
whatsnew
2832
bibliography
2933

34+
.. _index-conceptual:
35+
36+
Conceptual documentation
37+
========================
38+
39+
This section contains **conceptual and methodological** documentation
40+
of the ‘base’ or ‘main’ MESSAGEix-GLOBIOM global model,
41+
describing in detail how it represents global energy systems:
42+
43+
.. toctree::
44+
:maxdepth: 2
45+
:caption: Conceptual documentation
46+
:hidden:
47+
48+
global/index
49+
50+
- :doc:`global/index`
51+
52+
This is distinct from both
53+
the *technical* documentation in other sections and pages,
54+
which describe the code and data used to implement this representation,
55+
and the modules for various `model ‘variants’ <#index-variants>`_ that have similar, yet distinct, structure.
56+
3057
API reference
3158
=============
3259

@@ -81,12 +108,12 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
81108
api/testing
82109
api/tests
83110

111+
.. _index-variants:
84112

85113
.. toctree::
86114
:maxdepth: 2
87115
:caption: Model variants
88116

89-
global/index
90117
buildings/index
91118
material/index
92119
transport/index

0 commit comments

Comments
 (0)