Skip to content

Commit

Permalink
changed format of references to ixmp and message_ix classes
Browse files Browse the repository at this point in the history
  • Loading branch information
@francescolovat
francescolovat committed Apr 3, 2020
1 parent 96173fb commit a8b7aca
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions message_ix/model/MESSAGE/parameter_def.gms
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* .. caution::
*
* Parameters written in **bold** are auxiliary parameters
* that are either generated automatically when exporting a ``message_ix.Scenario`` to gdx
* that are either generated automatically when exporting a :class:`message_ix.Scenario` to gdx
* or that are computed during the *pre-processing* stage in GAMS (see the footnotes for more
* individual details). These are **not** meant to be edited through the API when editing scenarios.
*
Expand Down Expand Up @@ -51,13 +51,13 @@
* - Discount factor of the last year in the period [#df_auto]_
*
* .. [#duration_time_year] The element 'year' in the set of subannual time slices ``time`` has the value of 1.
* This value is assigned by default when creating a new ``ixmp.Scenario`` based on the ``MESSAGE`` scheme.
* This value is assigned by default when creating a new :class:`ixmp.Scenario` based on the ``MESSAGE`` scheme.
*
* .. [#short_dur] The short-hand notation :math:`|y|` is used for the parameters :math:`duration\_period_y`
* in the mathematical model documentation for exponents.
*
* .. [#year_auto] The values for this parameter are computed automatically when exporting a ``MESSAGE``-scheme
* ``ixmp.Scenario`` to gdx.
* :class:`ixmp.Scenario` to gdx.
* Note that in |MESSAGEix|, the elements of the ``year`` set are understood to be the last year in a period,
* see :ref:`this footnote <period_year_footnote>`.
*
Expand Down
20 changes: 10 additions & 10 deletions message_ix/model/MESSAGE/sets_maps_def.gms
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,15 @@ $ONEMPTY
* .. [#node] The set ``node`` includes spatial units across all levels of spatial disaggregation
* (global, regions, countries, basins, grid cells).
* The hierarchical mapping is implemented via the mapping set ``map_spatial_hierarchy``.
* This set always includes an element 'World' when initializing a ``MESSAGE``-scheme ``message_ix.Scenario``.
* This set always includes an element 'World' when initializing a ``MESSAGE``-scheme :class:`message_ix.Scenario`.
*
* .. [#mode] For example, high electricity or high heat production modes of operation for combined heat and power plants.
*
* .. [#year_all] In the |MESSAGEix| implementation in GAMS, the set ``year_all`` denotes the "superset"
* of the entire horizon (historical and model horizon), and the set ``year`` is a dynamic subset of ``year_all``.
* This facilitates an efficient implementation of the historical capacity build-up and
* the (optional) recursive-dynamic solution approach.
* When working with a ``message_ix.Scenario`` via the scientific programming API, the set of all periods is
* When working with a :class:`message_ix.Scenario` via the scientific programming API, the set of all periods is
* called ``year`` for a more concise notation.
* The specification of the model horizon is implemented using the mapping set ``cat_year``
* and the type "firstmodelyear".
Expand All @@ -108,7 +108,7 @@ $ONEMPTY
* the period '2010' comprises the years :math:`[2006, .. ,2010]`.
*
* .. [#time] The set ``time`` collects all sub-annual temporal units across all levels of temporal disaggregation.
* In a ``MESSAGE``-scheme ``ixmp.Scenario``, this set always includes an element "year",
* In a ``MESSAGE``-scheme :class:`ixmp.Scenario`, this set always includes an element "year",
* and the duration of that element is 1 (:math:`duration\_time_{'year'} = 1`).
*
* .. [#shares] A generic formulation of share constraints is implemented in |MESSAGEix|,
Expand Down Expand Up @@ -236,23 +236,23 @@ Alias(mode, mode2);
* .. [#level_res] The constraint :ref:`extraction_equivalence` is active only for the levels included in this set,
* and the constraint :ref:`commodity_balance` is deactivated for these levels.
*
* .. [#type_node] The element "economy" is added by default as part of the ``MESSAGE``-scheme ``ixmp.Scenario``.
* .. [#type_node] The element "economy" is added by default as part of the ``MESSAGE``-scheme :class:`ixmp.Scenario`.
*
* .. [#type_tec] The element "all" in ``type_tec`` and the associated mapping to all technologies in the set ``cat_tec``
* are added by default as part of the ``MESSAGE``-scheme ``message_ix.Scenario``.
* are added by default as part of the ``MESSAGE``-scheme :class:`message_ix.Scenario`.
*
* .. [#inv_tec] The auxiliary set ``inv_tec`` (subset of ``technology``) is a short-hand notation for all technologies
* with defined investment costs. This activates the investment cost part in the objective function and the
* constraints for all technologies where investment decisions are relevant.
* It is added by default when exporting ``MESSAGE``-scheme ``message_ix.Scenario`` to gdx.
* It is added by default when exporting ``MESSAGE``-scheme :class:`message_ix.Scenario` to gdx.
*
* .. [#renewable_tec] The auxiliary set ``renewable_tec`` (subset of ``technology``) is a short-hand notation
* for all technologies with defined parameters relevant for the equations in the "Renewable" section.
* It is added by default when exporting ``MESSAGE``-scheme ``message_ix.Scenario`` to gdx.
* It is added by default when exporting ``MESSAGE``-scheme :class:`message_ix.Scenario` to gdx.
*
* .. [#type_tec_land] The mapping set ``type_tec_land`` is a dynamic subset of ``type_tec`` and specifies whether
* emissions from the land-use model emulator module are included when aggregrating over a specific technology type.
* The element "all" is added by default in a ``MESSAGE``-scheme ``message_ix.Scenario``.
* The element "all" is added by default in a ``MESSAGE``-scheme :class:`message_ix.Scenario`.
***

* category types and mappings
Expand Down Expand Up @@ -289,7 +289,7 @@ Alias(type_tec,type_tec_total);
*
* .. note::
*
* These sets are **generated automatically** when exporting a ``MESSAGE``-scheme ``ixmp.Scenario`` to gdx using the API.
* These sets are **generated automatically** when exporting a ``MESSAGE``-scheme :class:`ixmp.Scenario` to gdx using the API.
* They are used in the GAMS model to reduce model size by excluding non-relevant variables and equations
* (e.g., activity of a technology outside of its technical lifetime). These are **not** meant to be
* edited through the API when editing scenarios. Not all the ``Mapping sets`` are shown in the list below, to access
Expand Down Expand Up @@ -368,7 +368,7 @@ Sets
* Mapping sets (flags) for bounds
* -------------------------------
*
* There are a number of mappings sets generated when exporting a ``message_ix.Scenario`` to gdx.
* There are a number of mappings sets generated when exporting a :class:`message_ix.Scenario` to gdx.
* They are used as 'flags' to indicate whether a constraint is active.
* The names of these sets follow the format ``is_<constraint>_<dir>``.
*
Expand Down

0 comments on commit a8b7aca

Please sign in to comment.