Skip to content

Commit 592d1cc

Browse files
authored
Merge pull request #495 from EnergySystemsModellingLab/optional_parameters
More clarity in the documentation about optional parameters
2 parents 3317a37 + b40e5d3 commit 592d1cc

5 files changed

Lines changed: 38 additions & 43 deletions

File tree

docs/inputs/agents.rst

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,12 @@ Objective1
103103

104104
.. _Objective2:
105105

106-
Objective2
106+
Objective2 (optional)
107107
Second objective. See :ref:`Objective1 <Objective1>`.
108108

109109
.. _Objective3:
110110

111-
Objective3:
111+
Objective3 (optional)
112112
Third objective. See :ref:`Objective1 <Objective1>`.
113113

114114
.. _ObjData1:
@@ -117,11 +117,11 @@ ObjData1
117117
A weight associated with the :ref:`first objective <Objective1>`. Whether it is used
118118
will depend in large part on the :ref:`decision method <DecisionMethod>`.
119119

120-
ObjData2
120+
ObjData2 (optional)
121121
A weight associated with the :ref:`second objective <Objective2>`. See :ref:`ObjData1
122122
<ObjData1>`.
123123

124-
ObjData3
124+
ObjData3 (optional)
125125
A weight associated with the :ref:`third objective <Objective3>`. See :ref:`ObjData1
126126
<ObjData1>`.
127127

@@ -132,15 +132,13 @@ Objsort1
132132
"adhoc" and "scipy" solvers this should be set to "True" for minimization and
133133
"False" for maximisation.
134134

135-
Objsort2
136-
Sets whether :ref:`second objective <Objective2>` is maximized or minimized. For both
137-
"adhoc" and "scipy" solvers this should be set to "True" for minimization and
138-
"False" for maximisation.
135+
Objsort2 (optional)
136+
Objsort parameter for :ref:`second objective <Objective2>`. See :ref:`Objsort1
137+
<Objsort1>`.
139138

140-
Objsort3
141-
Sets whether :ref:`third objective <Objective3>` is maximized or minimized. For both
142-
"adhoc" and "scipy" solvers this should be set to "True" for minimization and
143-
"False" for maximisation.
139+
Objsort3 (optional)
140+
Objsort parameter for :ref:`third objective <Objective3>`. See :ref:`Objsort1
141+
<Objsort1>`.
144142

145143
.. py:currentmodule:: muse.filters
146144
@@ -161,7 +159,7 @@ SearchRule
161159

162160
- :py:func:`similar_technology <similar_technology>`: Only allows technologies that
163161
have the same type as current crop of technologies in the agent, as determined by
164-
"tech_type" in :ref:`inputs-technodata`. Aliased to "similar".
162+
"Type" in :ref:`inputs-technodata`. Aliased to "similar".
165163

166164
- :py:func:`same_fuels <same_fuels>`: Only allows technologies that consume the same
167165
fuels as the current crop of technologies in the agent. Aliased to
@@ -219,8 +217,8 @@ DecisionMethod
219217
Quantity
220218
A factor used to determine the demand share of "New" agents.
221219

222-
MaturityThreshold
223-
Parameter for the search rule :py:func:`maturity <muse.filters.maturity>`.
220+
MaturityThreshold (optional)
221+
Required when using the :py:func:`maturity <muse.filters.maturity>` search rule.
224222

225-
SpendLimit
226-
Parameter for the search rule :py:func:`spend_limit <muse.filters.spend_limit>`.
223+
SpendLimit (optional)
224+
Required when using the :py:func:`spend_limit <muse.filters.spend_limit>` search rule.

docs/inputs/commodities.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,38 +16,36 @@ a whole are defined in a csv file with the following structure.
1616
Agricultural-residues, Energy, agrires, 112, 15.4, PJ
1717

1818
Commodity
19-
represents the extended name of a commodity
19+
represents the extended name of a commodity (e.g. "Heating" or "Electricity").
20+
21+
CommodityName
22+
the internal name used for a commodity inside the model (e.g. "heat" or "elec").
23+
Any references to commodities in other files must use these names.
2024

2125
CommodityType
2226
defines the type of a commodity (i.e. Energy, Service, Material, or Environmental).
2327

24-
The "energy" type includes the energy commodities, such as biomass, electricity, gasoline, and hydrogen,
28+
The "energy" type includes energy commodities, such as biomass, electricity, gasoline, and hydrogen,
2529
which are either extracted, transformed from one to another, or used in the energy system.
2630

2731
The "service" type includes commodities such as space heating or hot water which correspond to selected
2832
people's needs, and whose fulfillment requires energy uses.
2933

3034
The "material" type represent non-energy inputs for energy technologies, such as limestone or oxygen.
35+
3136
The "environmental" type refers to non-energy commodities whichare used to quantify an impact on the environment,
3237
such as greenhouse gases or CO2. They can be subjected to different types of environmental fees or taxes.
3338

34-
CommodityName
35-
is the internal name used for a commodity inside the model.
36-
37-
CommodityEmissionFactor_CO2
39+
CommodityEmissionFactor_CO2 (optional)
3840
is CO2 emission per unit of commodity flow.
3941
This commodity property is not directly used in the MUSE core set of equations, but can be further referred to
4042
for any subsequent development of the code.
4143

42-
HeatRate
44+
HeatRate (optional)
4345
represents the lower heating value of an energy commodity
4446
This commodity property is not directly used in the MUSE core set of equations, but can be further referred to
4547
for any subsequent development of the code.
4648

47-
Unit
48-
is the unit used as a basis for all the input data. More specifically the model allows
49-
a totally flexible way of defining the commodities. CommodityName is currently the
50-
only column used internally as it defines the names of commodities and needs to be
51-
used consistently across all the input data files. The remaining columns of the file
52-
are only relevant for the user internal reference for the original sets of
53-
assumptions used.
49+
Unit (optional)
50+
is the unit used to represent quantities of the commodity (e.g "PJ").
51+
This parameter does not need to be included, as it isn't used in the model, but care should be taken to ensure that units are consistent across all input files.

docs/inputs/existing_capacity.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ProcessName
2424
RegionName
2525
represents the region ID and needs to be consistent across all the data inputs.
2626

27-
Unit
27+
Unit (optional)
2828
reports the unit of the technology capacity; it is for the user internal reference only.
2929

3030
2010,..., 2050

docs/inputs/technodata.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,22 +114,22 @@ TechnicalLife
114114
UtilizationFactor
115115
represents the *maximum* actual output of the technology in a year, divided by the theoretical maximum output if the technology were operating at full capacity for the whole year. Must be between 0 and 1.
116116

117-
MinimumServiceFactor
117+
MinimumServiceFactor (optional, default = 0)
118118
Is the *minimum* output of the technology in a year, divided by the theoretical maximum output if the technology were operating at full capacity for the whole year. Must be between 0 and 1 and be smaller or equal than the `UtilizationFactor`. It is used to define the minimum service level that a technology must provide due to, typically, technical or efficiency constraints.
119119

120-
ScalingSize
121-
represents the reference capacity at which capital costs are estimated when used as agents' objective as described in :ref:`inputs-agents`.
120+
ScalingSize (optional)
121+
required when using the "capital_costs" agent objective. Represents the reference capacity at which capital costs are estimated when using this objective (see :ref:`inputs-agents`).
122122

123-
efficiency
124-
represents the technology efficiency used as agents' objective to sort investment according to their energy or material efficiency (see :ref:`inputs-agents`).
123+
efficiency (optional)
124+
represents the technology efficiency. Required when using the "efficiency" agent objective, which ranks investment options according to their energy or material efficiency (see :ref:`inputs-agents`).
125125

126-
Type
127-
defines the type of a technology. This variable is used for the search space in the agents csv file. It allows for the agents to filter for technologies of a similar type, for example.
126+
Type (optional)
127+
defines the type of a technology. Required when using the "similar_technology" search space, which allows agents to filter for technologies of a similar type (see :ref:`inputs-agents`).
128128

129-
Fuel
130-
defines the fuel used by a technology, defined to restrict the new investments of each agent to selected technologies using selected fuels (see :ref:`inputs-agents`).
129+
Fuel (optional)
130+
defines the fuel used by a technology. Required when using the "fueltype" search space, which allows agents to filter for technologies using the same fuel (see :ref:`inputs-agents`).
131131

132-
EndUse
132+
EndUse (optional)
133133
defines the end use of a technology, defined to restrict the new investments of each agent to selected technologies using selected end uses (see :ref:`inputs-agents`).
134134

135135
InterestRate

src/muse/filters.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,6 @@ def same_enduse(
239239
search_space: xr.DataArray,
240240
technologies: xr.Dataset,
241241
*args,
242-
enduse_label: str = "service",
243242
**kwargs,
244243
) -> xr.DataArray:
245244
"""Only allow for technologies with at least the same end-use."""

0 commit comments

Comments
 (0)