Parameter overview
This section contains an extensive table listing all input parameters that can be specified in ehubX models. The table provides information on whether a parameter is mandatory or optional, its default value (if applicable), the unit, and whether it can be defined as year-dependent or as a time series. Additionally, the table indicates the specific node paths within the input files where each parameter can be found. Please note the section about unit conventions mentioned at the beginning of the section input files which is also relevant for this section.
Legend
Name: Name of parameter (only used within this table)
- Mandatory: Whether this parameter has to be set for the model to be built correctly. Non-mandatory parameters usually have a default value. Used symbols are:
✓: Parameter is mandatory.
(✓): Parameter is mandatory under some conditions.
✖: Parameter is optional.
Default: Default value for optional parameters
Unit: Unit for the parameter (see units).
- Per year: Whether this parameter can be specified as year-dependent (see parameter types)
✓: Parameter can be specified as year-dependent.
✖: Parameter cannot be specified as year-dependent.
- Per ts: Whether this parameter can be specified as a timeseries (see parameter types). This will happen by specifying a path to a time series file, and the specific structure is dependent on the parameter itself.
✓: Parameter can be specified as a time series.
✖: Parameter cannot be specified as a time series.
Node path(s): Node path(s) (see node paths) within the file where this parameter is specified.
File: File in which this parameter is specified.
Parameter table
Name |
Mandatory |
Default |
Unit |
Per year |
Per ts |
Node path(s) |
File |
|---|---|---|---|---|---|---|---|
Autonomy unmet demand allowed (autonomy) |
✖ |
False |
✖ |
✖ |
|
||
Availability (ates) |
✖ |
1 |
[-] |
✓ |
✓ |
|
|
Availability (conversion) |
✖ |
1 |
[-] |
✓ |
✓ |
|
|
Availability (ebm) |
✖ |
1 |
[-] |
✓ |
✓ |
|
|
Availability (heatpump) |
✖ |
1 |
[-] |
✓ |
✓ |
|
|
Availability (net_links) |
✖ |
1 |
[-] |
✓ |
✓ |
|
|
Available area (ates) |
✖ |
\(\infty\) |
m^2 |
✓ |
✖ |
|
|
Bidirectional (link) |
✖ |
False |
✖ |
✖ |
|
||
Capacity factor (coupling) |
✓ |
CAP_sub/CAP_main |
✖ |
✖ |
|
||
CAPEX per capacity (load_shifting) |
✖ |
0 |
CHF/ec |
✖ |
✖ |
|
|
CAPEX per capacity (net_tech) |
✖ |
0 |
CHF/((ec/h)*m) |
✓ |
✖ |
|
|
CAPEX per capacity (tech) |
✖ |
0 |
CHF/CAP |
✓ |
✖ |
|
|
CO2 (import/export) |
✖ |
0 |
kg/ec |
✖ |
✓ |
|
|
CO2 per capacity (net_tech) |
✖ |
0 |
kg/((ec/h)*m) |
✓ |
✖ |
|
|
CO2 per capacity (tech) |
✖ |
0 |
kg/CAP |
✓ |
✖ |
|
|
CO2 per transported energy (net_tech) |
✖ |
0 |
kg/(ec*m) |
✓ |
✖ |
|
|
CO2 max (stage) |
✖ |
\(\infty\) |
kg |
✖ |
✖ |
|
|
CO2 min (stage) |
✖ |
\(-\infty\) |
kg |
✖ |
✖ |
|
|
CO2 price (stage) |
✖ |
0 |
CHF/kg |
✖ |
✖ |
|
|
COP (heatpump) |
(✓) |
[-] |
✓ |
✓ |
|
||
COP factor (heatpump) |
(✓) |
[-] |
✓ |
X |
|
||
Darcy velocity (ates) |
(✓) |
m/d |
✖ |
✖ |
|
||
Demand (demand) |
✖ |
0 |
ec |
✖ |
✓ |
|
|
Demand modifier (ebm) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Discharge controllability (ebm) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Electricity consumption per cooling energy (ates) |
(✓) |
[-] |
✖ |
✖ |
|
||
Electricity consumption per heating energy (ates) |
(✓) |
[-] |
✖ |
✖ |
|
||
Enabled (load_shedding) |
✖ |
True |
✖ |
✖ |
|
||
End of cold-to-warm phase (ates) |
✓ |
✖ |
✖ |
|
|||
End of warm-to-cold phase (ates) |
✓ |
✖ |
✖ |
|
|||
Energy cost (load_shedding) |
✖ |
0 |
CHF/ec |
✖ |
✖ |
|
|
Energy cost, above (load_shifting) |
✖ |
0 |
CHF/ec |
✖ |
✓ |
|
|
Energy cost, below (load_shifting) |
✖ |
0 |
CHF/ec |
✖ |
✓ |
|
|
Fix cost (load_shifting) |
✖ |
0 |
CHF/h |
✖ |
✓ |
|
|
Fluid density (ates) |
✓ |
kg/m^3 |
✖ |
✖ |
|
||
Fluid specific heat capacity (ates) |
✓ |
Ws/(kg*K) |
✖ |
✖ |
|
||
heur_max (ec) |
(✓) |
ec/h |
|
||||
heur_sum_max (ec) |
(✓) |
ec |
|
||||
imp_exp_type (self-sufficiency) |
✖ |
“none” |
✖ |
✖ |
|
||
Initial age (net_tech) |
✖ |
0 |
a |
✖ |
✖ |
|
|
Initial age (tech) |
✖ |
0 |
a |
✖ |
✖ |
|
|
Initial capacity (load_shifting) |
✖ |
0 |
ec |
✖ |
✖ |
|
|
Initial capacity (net_tech) |
✖ |
0 |
ec/h |
✖ |
✖ |
|
|
Initial capacity (tech) |
✖ |
0 |
CAP |
✖ |
✖ |
|
|
Initial stage of charge (ebm) |
✖ |
\(\infty\) |
[-] |
✖ |
✖ |
|
|
Initial stage of charge (storage) |
✖ |
\(\infty\) |
[-] |
✖ |
✖ |
|
|
Input efficiency (ebm) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Input efficiency (storage) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Input part (conversion) |
✓ |
ec_in |
✓ |
✖ |
|
||
Interest rate default (system) |
✓ |
[-] |
✖ |
✖ |
|
||
Interest rate (net_tech) |
✖ |
[-] |
✖ |
✖ |
|
||
Interest rate (tech) |
✖ |
[-] |
✖ |
✖ |
|
||
Interval length (load_shifting) |
✓ |
h |
✖ |
✖ |
|
||
is_energy (self-sufficiency) |
✖ |
True |
✖ |
✖ |
|
||
Last installation year (tech) |
✖ |
\(\infty\) |
✖ |
✖ |
|
||
Length (link) |
✓ |
m |
✖ |
✖ |
|
||
Lifetime (net_tech) |
✓ |
a |
✖ |
✖ |
|
||
Lifetime (tech) |
✓ |
a |
✖ |
✖ |
|
||
Main input ec (conversion) |
(✓) |
✖ |
✖ |
|
|||
Main output ec (conversion) |
(✓) |
✖ |
✖ |
|
|||
Main tech id (coupling) |
✓ |
✖ |
✖ |
|
|||
Max (import/export) |
✖ |
\(\infty\) |
ec/h |
✖ |
✓ |
|
|
Maximal self-sufficiency (self-sufficiency) |
✖ |
1 |
[-] |
|
|||
Maximal capacity (link) |
✖ |
\(\infty\) |
ec/h |
✓ |
✖ |
|
|
Maximal capacity (load_shifting) |
✖ |
\(\infty\) |
ec |
✖ |
✖ |
|
|
Maximal capacity (tech) |
✖ |
\(\infty\) |
CAP |
✓ |
✖ |
|
|
Maximal charging power (ebm) |
✖ |
\(\infty\) |
ec/h |
✓ |
✖ |
|
|
Maximal charging power (storage) |
✖ |
\(\infty\) |
1/h |
✓ |
✖ |
|
|
Maximal curtailment (solar) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Maximal discharging power (ebm) |
✖ |
\(\infty\) |
ec/h |
✓ |
✖ |
|
|
Maximal discharging power (storage) |
✖ |
\(\infty\) |
1/h |
✓ |
✖ |
|
|
Maximal drawdown of aquifer (ates) |
(✓) |
m |
✖ |
✖ |
|
||
Maximal total heating over cooling (ates) |
✖ |
\(\infty\) |
[-] |
✓ |
✖ |
|
|
Maximal total cooling over heating (ates) |
✖ |
\(\infty\) |
[-] |
✓ |
✖ |
|
|
Maximal load shedding, absolute (load_shedding) |
✖ |
\(\infty\) |
ec/h |
✖ |
✖ |
|
|
Maximal load shedding, relative (load_shedding) |
✖ |
1 |
[-] |
✖ |
✖ |
|
|
Maximal load shifting, absolute-above (load_shifting) |
✖ |
\(\infty\) |
ec/h |
✖ |
✓ |
|
|
Maximal load shifting, absolute-below (load_shifting) |
✖ |
\(\infty\) |
ec/h |
✖ |
✓ |
|
|
Maximal load shifting, relative-above (load_shifting) |
✖ |
\(\infty\) |
[-] |
✖ |
✓ |
|
|
Maximal load shifting, relative-below (load_shifting) |
✖ |
1 |
[-] |
✖ |
✓ |
|
|
Maximal number of well pairs (ates) |
✖ |
\(\infty\) |
✓ |
✖ |
|
||
Maximal pumping rate per cold well (ates) |
✖ |
m^3/h |
✓ |
✖ |
|
||
Maximal pumping rate per warm well (ates) |
✖ |
m^3/h |
✓ |
✖ |
|
||
Maximal stage of charge (storage) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Maximal summed-up backward transport (link) |
✖ |
\(\infty\) |
ec |
✓ |
✖ |
|
|
Maximal summed-up forward transport (link) |
✖ |
\(\infty\) |
ec |
✓ |
✖ |
|
|
Maximal summed-up imports/exports (import/export) |
✖ |
\(\infty\) |
ec |
✖ |
✖ |
|
|
Maximal summed-up output (conversion) |
✖ |
\(\infty\) |
ec |
✓ |
✖ |
|
|
Maximal temperature spread for cold wells (ates) |
✓ |
K |
✖ |
✖ |
|
||
Maximal temperature spread for warm wells (ates) |
✓ |
K |
✖ |
✖ |
|
||
Min (import/export) |
✖ |
0 |
ec/h |
✖ |
✓ |
|
|
Minimal number of well pairs (ates) |
✖ |
0 |
✓ |
✖ |
|
||
Minimal summed-up backward transport (link) |
✖ |
\(\infty\) |
ec |
✓ |
✖ |
|
|
Maximal summed-up forward transport (link) |
✖ |
\(\infty\) |
ec |
✓ |
✖ |
|
|
Maximal summed-up imports/exports (import/export) |
✖ |
\(\infty\) |
ec |
✖ |
✖ |
|
|
Maximal summed-up output (conversion) |
✖ |
\(\infty\) |
ec_out_main |
✓ |
✖ |
|
|
Min (import/export) |
✖ |
0 |
ec/h |
✖ |
✓ |
|
|
Minimal self-sufficiency (self-sufficiency) |
✖ |
0 |
[-] |
|
|||
Minimal capacity (link) |
✖ |
0 |
ec/h |
✓ |
✖ |
|
|
Minimal capacity (load_shifting) |
✖ |
0 |
ec |
✖ |
✖ |
|
|
Minimal capacity (tech) |
✖ |
0 |
CAP |
✓ |
✖ |
|
|
Minimal stage of charge (ebm) |
✖ |
0 |
[-] |
✓ |
✖ |
|
|
Minimal stage of charge (storage) |
✖ |
0 |
[-] |
✓ |
✖ |
|
|
Minimal summed-up backward transport (link) |
✖ |
0 |
ec |
✓ |
✖ |
|
|
Minimal summed-up forward transport (link) |
✖ |
0 |
ec |
✓ |
✖ |
|
|
Minimal summed-up imports/exports (import/export) |
✖ |
0 |
ec |
✖ |
✖ |
|
|
Minimal summed-up output (conversion) |
✖ |
0 |
ec_out_main |
✓ |
✖ |
|
|
Minimal unit capacity (net_tech) |
✖ |
0 |
ec/h |
✓ |
✖ |
|
|
Minimal unit capacity (tech) |
✖ |
0 |
CAP |
✓ |
✖ |
|
|
Nominal demand (ebm) |
✖ |
0 |
ec/h |
✓ |
✓ |
|
|
Number of horizon timesteps (system) |
✓ |
✖ |
✖ |
|
|||
Number of vehicles (ebm) |
✓ |
✓ |
✖ |
|
|||
One-time CAPEX cost (net_tech) |
✖ |
0 |
CHF/m |
✓ |
✖ |
|
|
One-time CAPEX cost (tech) |
✖ |
0 |
CHF |
✓ |
✖ |
|
|
One-time OPEX cost (net_tech) |
✖ |
0 |
CHF/m |
✓ |
✖ |
|
|
One-time OPEX cost (tech) |
✖ |
0 |
CHF |
✓ |
✖ |
|
|
OPEX cost per capacity (tech) |
✖ |
0 |
CHF/CAP |
✓ |
✖ |
|
|
OPEX cost per capacity (net_tech) |
✖ |
0 |
CHF/((ec/h)*m) |
✓ |
✖ |
|
|
OPEX per output energy (conversion) |
✖ |
0 |
CHF/out_ec_main |
✓ |
✖ |
|
|
OPEX per transported energy (net_tech) |
✖ |
0 |
CHF/(ec*m) |
✓ |
✖ |
|
|
Output ec (conversion) |
✓ |
✖ |
✖ |
|
|||
Output efficiency (conversion) |
✓ |
ec_out/ec_in_main |
✓ |
✓ |
|
||
Output efficiency (EBM) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Output efficiency (storage) |
✖ |
1 |
[-] |
✓ |
✖ |
|
|
Peak cost, above (load_shifting) |
✖ |
0 |
CHF/(ec/h) |
✖ |
✖ |
|
|
Peak cost, below (load_shifting) |
✖ |
0 |
CHF/(ec/h) |
✖ |
✖ |
|
|
(Effective) Porosity of aquifer (ates) |
(✓) |
[-] |
✖ |
✖ |
|
||
Price (import/export) |
✖ |
0 |
CHF/ec |
✖ |
✓ |
|
|
Rock density (ates) |
(✓) |
Ws/(kg*K) |
✖ |
✖ |
|
||
Rock specific heat capacity (ates) |
(✓) |
Ws/(kg*K) |
✖ |
✖ |
|
||
Self-sufficiency calculation method (self-sufficiency) |
✖ |
“none” |
|
||||
Solar area (solar) |
✖ |
0 |
m^2 |
✖ |
✖ |
||
Solar irradiation (solar) |
✖ |
0 |
(ec/h)/m^2 |
✖ |
✖ |
||
Stages (load_shedding) |
✓ |
✖ |
✖ |
|
|||
Stages (load_shifting) |
✓ |
✖ |
✖ |
|
|||
Start of cold-to-warm phase (ates) |
✓ |
✖ |
✖ |
|
|||
Start of warm-to-cold phase (ates) |
✓ |
✖ |
✖ |
|
|||
Start year (stage) |
✓ |
✖ |
✖ |
|
|||
Standby loss (ebm) |
✖ |
0 |
[-] |
✓ |
✖ |
|
|
Standby loss (storage) |
✖ |
0 |
[-] |
✓ |
✖ |
|
|
Storage capacity (ebm) |
✓ |
ec |
✓ |
✖ |
|
||
Temperature, heating inlet (heatpump) |
(✓) |
K |
✓ |
✓ |
|
||
Temperature, heating outlet (heatpump) |
(✓) |
K |
✓ |
✓ |
|
||
Thermal radius per cold well (ates) |
✖ |
m |
✓ |
✖ |
|
||
Thermal radius per warm well (ates) |
✖ |
m |
✓ |
✖ |
|
||
Thickness of aquifer (ates) |
(✓) |
m |
✖ |
✖ |
|
||
Transmission decay (net_tech) |
✖ |
0 |
1/m |
✓ |
✖ |
|
|
TRL (net_tech) |
✖ |
\(\infty\) |
✓ |
✖ |
|
||
TRL (tech) |
✖ |
\(\infty\) |
✓ |
✖ |
|
||
TRL threshold (system) |
✖ |
0 |
✖ |
✖ |
|
||
Well pair area calculation method (ates) |
✖ |
“smallest rectangle” |
✖ |
✖ |
|
||
Well distance (ates) |
(✓) |
m |
✓ |
✖ |
|
||
Well radius (ates) |
(✓) |
m |
✖ |
✖ |
|