You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/index.rst
+30-3Lines changed: 30 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,12 @@
1
1
Tools for MESSAGEix-GLOBIOM models
2
2
**********************************
3
3
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/>`_.
6
10
7
11
Among other tasks, the tools allow modelers to:
8
12
@@ -27,6 +31,29 @@ Among other tasks, the tools allow modelers to:
27
31
whatsnew
28
32
bibliography
29
33
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
+
30
57
API reference
31
58
=============
32
59
@@ -81,12 +108,12 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
0 commit comments