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/api/tools-costs.rst
+39-28Lines changed: 39 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,31 +36,33 @@ Non-reference regions
36
36
Modules and model variants
37
37
==========================
38
38
39
-
Within the context of the tool, the term **module** (specified by :attr:`.Config.module`) is used to mean input data for particular *sets of technologies*.
40
-
These correspond to subsets of all the technologies in MESSAGEix-GLOBIOM models—either the base model or model variants. [3]_
41
-
Currently, :mod:`.tools.costs` supports two module :attr:`~.Config.module` settings:
42
-
43
-
"energy"
44
-
Mostly electric power technologies, as well as a few other supply-side technologies.
45
-
46
-
This can be considered the "base" module, corresponding to the "base" version of MESSAGEix-GLOBIOM, as it contains the most technologies.
47
-
48
-
"materials"
49
-
Technologies conceived as part of the materials and industry sectors.
50
-
51
-
"cooling"
52
-
Cooling technologies for power plants.
39
+
Within the context of the tool,
40
+
the term **‘module’** is used to refer to input data for particular *sets of technologies*.
41
+
These correspond to subsets of all the technologies in MESSAGEix-GLOBIOM models
42
+
—either the base model or model variants.
43
+
The tool supports all the modules enumerated by :class:`.costs.MODULE`;
44
+
these are specified by setting :attr:`.Config.module` on a new or existing instance.
45
+
See the documentation of :class:`.MODULE` for longer descriptions of the scope of each.
46
+
47
+
.. note::
48
+
This usage of “module” differs from the meaning of a “Python module”.
49
+
For instance, :mod:`message_ix_models.model.water` is a *Python module* for MESSAGEix-Nexus.
50
+
If the setting :py:`.costs.Config.module = MODULE.water` existed,
51
+
this *could*, but would *not necessarily*,
52
+
refer to input data for projecting investment and fixed costs of water technologies
53
+
that are defined in :mod:`message_ix_models.model.water`.
54
+
The existence of any Python module does not imply that it is supported by :mod:`.tools.costs`.
53
55
54
56
Data and files for a particular module can refer to other modules.
55
-
This allows for values or settings for "materials" and other technologies to be assumed to match the values and settings used for the referenced "energy"-module technologies.
56
-
57
-
.. [3] This usage of “module” differs from the meaning of a “Python module”.
58
-
For instance, :mod:`message_ix_models.model.water` is a *Python module* for MESSAGEix-Nexus.
59
-
If the setting :py:`.costs.Config.module = "water"` were added, this *might* refer to input data for projecting investment and fixed costs of water technologies that are defined in :mod:`message_ix_models.model.water`—but not necessarily.
57
+
This allows to implement the assumption that values or settings for certain technologies in,
58
+
for instance, :attr:`.MODULE.materials`,
59
+
match the values and settings used for certain referenced :attr:`.MODULE.energy` technologies.
60
60
61
61
To add a new module, the following steps are required:
62
62
63
-
- In :file:`message_ix_models/data/costs/`, create another subdirectory with the name of the new module, for instance :file:`message_ix_models/data/costs/[module]/`.
63
+
- Add a new member to the :class:`.MODULE` enumeration.
64
+
The name of the member is the name of the module.
65
+
- In :file:`message_ix_models/data/costs/`, create another subdirectory with same name, for instance :file:`message_ix_models/data/costs/[module]/`.
64
66
- Add the following files to the new directory:
65
67
66
68
:file:`first_year_[module].csv`
@@ -84,16 +86,25 @@ To add a new module, the following steps are required:
84
86
- "base_year_reference_region_cost": the base year cost for the technology in the reference region.
85
87
- "fix_ratio": the ratio of fixed O&M costs to investment costs for the technology.
86
88
87
-
- Add the new module to the allowed values of :attr:`.Config.module`.
88
-
89
89
Please note that the following assumptions are made in technology costs mapping:
90
90
91
-
- If a technology is mapped to a technology in the "energy" module, then the cost reduction across scenarios is the same as the cost reduction of the mapped technology.
92
-
- If a non-"energy" module (such as "materials" or "cooling") technology has :py:`reg_diff_source="energy"` and the "base_year_reference_region_cost" is not empty, then the "base_year_reference_region_cost" in :file:`tech_map_[module].csv` is used as the base year cost for the technology in the reference region.
93
-
If the "base_year_reference_region_cost" is empty, then the cost reduction across scenarios is the same as the cost reduction of the mapped technology.
94
-
- If using a non-"energy" module (such as "materials" or "cooling"), if a technology that is specified in :file:`tech_map_materials.csv` already exists in :file:`tech_map_energy.csv`, then the reference region cost is taken from :file:`tech_map_materials.csv`.
95
-
- If a technology in a module is not mapped to any source of regional differentiation, then no cost reduction over the years is applied to the technology.
96
-
- If a technology has a non-empty "base_year_reference_region_cost" but is not mapped to any source of regional differentiation, then assume no regional differentiation and use the reference region base year cost as the base year cost for all regions.
91
+
- If a technology is mapped to a technology in the "energy" module,
92
+
then the cost reduction across scenarios is the same as the cost reduction of the mapped technology.
93
+
- If a non-"energy" module (such as "materials" or "cooling") technology has :py:`reg_diff_source="energy"`
94
+
and the "base_year_reference_region_cost" is not empty,
95
+
then the "base_year_reference_region_cost" in :file:`tech_map_[module].csv` is used
96
+
as the base year cost for the technology in the reference region.
97
+
If the "base_year_reference_region_cost" is empty,
98
+
then the cost reduction across scenarios is the same as the cost reduction of the mapped technology.
99
+
- If using a non-"energy" module (such as "materials" or "cooling"),
100
+
and a technology that is specified in :file:`tech_map_materials.csv` already exists in :file:`tech_map_energy.csv`,
101
+
then the reference region cost is taken from :file:`tech_map_materials.csv`.
102
+
- If a technology in a module is not mapped to any source of regional differentiation,
103
+
then no cost reduction over the years is applied to the technology.
104
+
- If a technology has a non-empty "base_year_reference_region_cost"
105
+
but is not mapped to any source of regional differentiation,
106
+
then assume no regional differentiation
107
+
and use the reference region base year cost as the base year cost for all regions.
0 commit comments