Input parameters¶
Table of parameters¶
The input parameters are gathered in the table below. Each parameter is provided with unit, type and example values. For more information about one parameter, please click on it.
Parameter |
Type |
Unit |
Default |
---|---|---|---|
numeric |
a |
0 |
|
numeric |
Factor |
1 |
|
str |
|||
str |
|||
numeric |
€ |
0 |
|
numeric |
Factor |
0.05 |
|
numeric |
€/kWh |
0.01 |
|
numeric |
Factor |
0.8 |
|
numeric |
kgCO2eq/asset unit |
0.4 |
|
numeric |
€/kWh |
0.3 |
|
str |
Electricity |
||
numeric |
365 |
||
numeric |
|
||
numeric |
€/kWh |
0.1 |
|
str |
|||
numeric |
factor |
0 |
|
numeric |
factor |
0 |
|
str |
|||
numeric |
|
0 |
|
str |
|||
numeric |
|||
numeric |
a |
20 |
|
numeric |
|||
numeric |
kgCO2eq/a |
||
numeric |
|
||
numeric |
factor |
0.6 |
|
numeric |
factor |
0.8 |
|
boolean |
False |
||
boolean |
False |
||
str |
|||
boolean |
False |
||
numeric |
€/kW |
0 |
|
numeric |
times per year |
1 |
|
numeric |
a |
20 |
|
str |
|||
str |
|||
numeric |
Factor |
0.44 |
|
boolean |
True |
||
str |
|||
str |
|||
str |
|||
numeric |
None or factor |
||
numeric |
Factor |
1 |
|
numeric |
Factor |
0 |
|
numeric |
€/:unit: |
1000 |
|
numeric |
€/(:unit:*a) |
10 |
|
str |
|||
str |
|||
numeric |
Factor |
0 |
|
numeric |
60 |
||
str |
|||
str |
kW |
||
factor |
beta |
0 |
List of parameters¶
Below is the list of all the parameters of the open-plan-tool, sorted in alphabetical order. Each of the parameters has the following properties
- Definition:
parameter’s definition, could also contain potential use cases of the parameter
- Type:
str (text), numeric (integer or double precision number), boolean (True or False)
- Unit:
physical unit
- Example:
an example of parameter’s value
- Restrictions:
specific restrictions on the parameter’s value (e.g., “positive integer number”, “must be an even number”, “must be one of [‘val1’, ‘val2’]”
- Default:
default parameter’s value
age_installed¶
- Definition_Short:
Number of years the asset has already been in operation
- Definition_Long:
If the project lasts longer than its remaining lifetime, the replacement costs of the asset will be taken into account.
- Type:
numeric
- Unit:
a
- Example:
10
- Restrictions:
Natural number
- Default:
0
c-rate¶
- Definition_Short:
Maximum permissable power at which the storage can be charged or discharged relative to the nominal capacity of the storage
- Definition_Long:
The C rate indicates the reciprocal of the time for which a battery of the specified capacity can be charged or discharged with the maximum charge or discharge current. A C-rate of 1 implies that the battery can be fully charged or discharged completely in a single timestep. A C-rate of 0.5 implies that the battery needs at least 2 timesteps to be fully charged or discharged.
- Type:
numeric
- Unit:
Factor
- Example:
1
- Restrictions:
Real number between 0 and 1
- Default:
1
country¶
- Definition_Short:
Name of the country where the project is being deployed
- Type:
str
- Unit:
nan
- Example:
Norway
- Restrictions:
nan
- Default:
nan
currency¶
- Definition_Short:
The currency of the country where the project is implemented
- Type:
str
- Unit:
nan
- Example:
EUR
- Restrictions:
nan
- Default:
nan
development_costs¶
- Definition_Short:
Planning and development costs
- Definition_Long:
This could be planning and development costs which do not depend on the (optimized) capacities of the assets.
- Type:
numeric
- Unit:
€
- Example:
10000
- Restrictions:
Positive real number
- Default:
0
discount_factor¶
- Definition_Short:
The factor which accounts for the depreciation in the value of money in the future compared to the current value of the same money
- Definition_Long:
The common method is to calculate the weighted average cost of capital (WACC) and use it as the discount rate.
- Type:
numeric
- Unit:
Factor
- Example:
0.06
- Restrictions:
Real number
- Default:
0.05
dispatch_price¶
- Definition_Short:
Costs associated with a flow through/from the asset (OPEX_var or fuel costs)
- Definition_Long:
This could be fuel costs for fuel sources like biogas or oil or operational costs for thermal power plants which only occur when operating the plant.
- Type:
numeric
- Unit:
€/kWh
- Example:
0.01
- Restrictions:
nan
- Default:
0.01
efficiency¶
- Definition_Short:
Ratio of energy output to energy input
- Definition_Long:
The battery efficiency is the ratio of the energy taken out from the battery to the energy put into the battery.
- Type:
numeric
- Unit:
Factor
- Example:
0.95
- Restrictions:
Positive real number
- Default:
0.8
emission_factor¶
- Definition_Short:
Emissions per unit dispatch of an asset
- Type:
numeric
- Unit:
kgCO2eq/asset unit
- Example:
14.4
- Restrictions:
Positive real number
- Default:
0.4
energy_price¶
- Definition_Short:
Price of the energy carrier sourced from the utility grid
- Definition_Long:
Can be also a timeseries
- Type:
numeric
- Unit:
€/kWh
- Example:
0.3
- Restrictions:
nan
- Default:
0.3
energyVector¶
- Definition_Short:
Energy commodity
- Definition_Long:
Convention: For an energy conversion asset define the commodity of the output. For a sink define the commodity based on the input flow. For a source define the commodity based on the output flow. For a storage, define the commodity based on the stored energy carrier.
- Type:
str
- Unit:
nan
- Example:
Electricity
- Restrictions:
One of “Electricity”, “Gas”, “Bio-Gas”, “Diesel”, “Heat”, “H2”
- Default:
Electricity
evaluated_period¶
- Definition_Short:
The number of days for which the simulation is to be run
- Type:
numeric
- Unit:
nan
- Example:
365
- Restrictions:
Natural number
- Default:
365
feedin_cap¶
- Definition_Short:
Maximum capacity for feeding electricity into the grid
- Type:
numeric
- Unit:
- unit:
- Example:
1000
- Restrictions:
Acceptable values are either a positive real number or None
- Default:
nan
feedin_tariff¶
- Definition_Short:
Price received for feeding electricity into the grid
- Definition_Long:
Can be also a timeseries
- Type:
numeric
- Unit:
€/kWh
- Example:
0.1
- Restrictions:
nan
- Default:
0.1
file_name¶
- Definition_Short:
Name of the csv file containing the input generation or demand timeseries
- Type:
str
- Unit:
nan
- Example:
demand_harbor.csv
- Restrictions:
This file must be placed in a folder named “time_series” inside your input folder.
- Default:
nan
fixed_thermal_losses_absolute¶
- Definition_Short:
Thermal losses of the storage independent of the state of charge and independent of nominal storage capacity between two consecutive timesteps
- Type:
numeric
- Unit:
factor
- Example:
0.0003
- Restrictions:
Between 0 and 1
- Default:
0
fixed_thermal_losses_relative¶
- Definition_Short:
Thermal losses of storage independent of state of charge between two consecutive timesteps relative to nominal storage capacity
- Type:
numeric
- Unit:
factor
- Example:
0.0016
- Restrictions:
Between 0 and 1
- Default:
0
inflow_direction¶
- Definition_Short:
Label of the bus/component from which the energyVector is arriving into the asset
- Type:
str
- Unit:
nan
- Example:
Electricity
- Restrictions:
nan
- Default:
nan
installedCap¶
- Definition_Short:
Already existing installed capacity
- Definition_Long:
If the project lasts longer than its remaining lifetime, the replacement costs of the asset will be taken into account.
- Type:
numeric
- Unit:
- unit:
- Example:
50
- Restrictions:
nan
- Default:
0
label¶
- Definition_Short:
Name of the asset
- Type:
str
- Unit:
nan
- Example:
pv_plant_01
- Restrictions:
Input the names in a computer friendly format, preferably with underscores instead of spaces, and avoiding special characters
- Default:
nan
latitude¶
- Definition_Short:
Latitude coordinate of the project’s geographical location
- Type:
numeric
- Unit:
nan
- Example:
45.641603
- Restrictions:
Should follow geographical convention
- Default:
nan
lifetime¶
- Definition_Short:
Number of operational years of the asset until it has to be replaced
- Type:
numeric
- Unit:
a
- Example:
20
- Restrictions:
Natural number
- Default:
20
longitude¶
- Definition_Short:
Longitude coordinate of the project’s geographical location
- Type:
numeric
- Unit:
nan
- Example:
10.95787
- Restrictions:
Should follow geographical convention
- Default:
nan
maximum_emissions¶
- Definition_Short:
Maximum amount of total emissions which are allowed in the optimized energy system
- Type:
numeric
- Unit:
kgCO2eq/a
- Example:
100000
- Restrictions:
Acceptable values are either a positive real number or None.
- Default:
nan
maximumCap¶
- Definition_Short:
Maximum total capacity of an asset that can be installed at the project site
- Definition_Long:
This includes the already existing installed and additional capacity possible. An example would be that a roof can only carry 50 kW PV (maximum capacity), whereas the installed capacity is already 10 kW. The optimization would only be allowed to add 40 kW PV at maximum.
- Type:
numeric
- Unit:
- unit:
- Example:
1000
- Restrictions:
Acceptable values are either a positive real number or None.
- Default:
nan
minimal_degree_of_autonomy¶
- Definition_Short:
Minimum degree of autonomy that needs to be met by the optimization
- Definition_Long:
This constraint defines a lower bound on the <a href=’https://open-plan-documentation.readthedocs.io/en/latest/model/simulation_outputs.html#degree-of-autonomy’>degree of autonomy</a> of the energy system. Note that constraint is applied to the the whole, sector-coupled energy system, but not to specific sectors individually.
- Type:
numeric
- Unit:
factor
- Example:
0.6
- Restrictions:
Real number between 0 and 1
- Default:
0.6
minimal_renewable_factor¶
- Definition_Short:
Minimum share of energy supplied by renewable generation that needs to be met by the optimization
- Definition_Long:
This constraint defines a lower bound on the <a href=’https://open-plan-documentation.readthedocs.io/en/latest/model/simulation_outputs.html#renewable-factor’>renewable share</a> of the system, which takes into account both local generation as well as the renewable share of energy providers. Note that constraint is applied to the renewable share of the whole, sector-coupled energy system, but not to specific sectors individually.
- Type:
numeric
- Unit:
factor
- Example:
0.8
- Restrictions:
Real number between 0 and 1
- Default:
0.8
net_zero_energy¶
- Definition_Short:
Specifies whether optimization needs to result into a net zero energy system (True) or not (False)
- Type:
boolean
- Unit:
nan
- Example:
True
- Restrictions:
Acceptable values are either Yes or No.
- Default:
False
optimizeCap¶
- Definition_Short:
Choose if capacity optimization should be performed for this asset.
- Type:
boolean
- Unit:
nan
- Example:
True
- Restrictions:
Acceptable values are either Yes or No.
- Default:
False
outflow_direction¶
- Definition_Short:
Label of bus/component towards which the energyVector is leaving from the asset
- Type:
str
- Unit:
nan
- Example:
PV plant (mono)
- Restrictions:
nan
- Default:
nan
output_lp_file¶
- Definition_Short:
Enables the output of the linear programming (lp) file with the linear equation system describing the optimization problem
- Definition_Long:
The lp file contains the objective function and all constraints. It enables the user to look at the underlying equations of the optimization.
- Type:
boolean
- Unit:
nan
- Example:
False
- Restrictions:
Acceptable values are either True or False
- Default:
False
peak_demand_pricing¶
- Definition_Short:
Grid fee to be paid based on the peak demand of a given period
- Type:
numeric
- Unit:
€/kW
- Example:
60
- Restrictions:
nan
- Default:
0
peak_demand_pricing_period¶
- Definition_Short:
Number of reference periods in one year for the peak demand pricing
- Type:
numeric
- Unit:
times per year
- Example:
2
- Restrictions:
Only one of the following are acceptable values: 1 (yearly), 2, 3 ,4, 6, 12 (monthly)
- Default:
1
project_duration¶
- Definition_Short:
The number of years the project is intended to be operational
- Definition_Long:
The project duration also sets the installation time of the assets used in the simulation. After the project ends these assets are ‘sold’ and the refund is charged against the initial investment costs.
- Type:
numeric
- Unit:
a
- Example:
30
- Restrictions:
Natural number
- Default:
20
project_id¶
- Definition_Short:
Assign a project ID as per your preference.
- Type:
str
- Unit:
nan
- Example:
1
- Restrictions:
Cannot be the same as an already existing project ID
- Default:
nan
project_name¶
- Definition_Short:
Assign a project name as per your preference.
- Type:
str
- Unit:
nan
- Example:
Borg Havn
- Restrictions:
nan
- Default:
nan
renewableAsset¶
- Definition_Short:
Choose if this asset should be considered as renewable.
- Definition_Long:
This parameter is necessary to consider the renewable share constraint correctly.
- Type:
boolean
- Unit:
nan
- Example:
True
- Restrictions:
Acceptable values are either Yes or No.
- Default:
True
scenario_description¶
- Definition_Short:
Brief description of the scenario being simulated
- Type:
str
- Unit:
nan
- Example:
This scenario simulates a sector-coupled energy system
- Restrictions:
nan
- Default:
nan
scenario_id¶
- Definition_Short:
Assign a scenario ID as per your preference.
- Type:
str
- Unit:
nan
- Example:
1
- Restrictions:
Cannot be the same as an already existing scenario ID within the project
- Default:
nan
scenario_name¶
- Definition_Short:
Assign a scenario name as per your preference.
- Type:
str
- Unit:
nan
- Example:
Warehouse 14
- Restrictions:
nan
- Default:
nan
soc_initial¶
- Definition_Short:
State of charge of the storage in the zeroth time step
- Definition_Long:
The state of charge is specified as a factor of the nominal capacity.
- Type:
numeric
- Unit:
None or factor
- Example:
nan
- Restrictions:
nan
- Default:
nan
soc_max¶
- Definition_Short:
The maximum permissible level of charge of the storage as a factor of the nominal capacity
- Definition_Long:
When the battery is filled to its nominal capacity the state of charge is represented by the value 1.
- Type:
numeric
- Unit:
Factor
- Example:
nan
- Restrictions:
Real number between 0 and 1
- Default:
1
soc_min¶
- Definition_Short:
The minimum permissible level of charge of the storage as a factor of the nominal capacity
- Definition_Long:
When the battery is fully discharged the state of charge is represented by the value 0.
- Type:
numeric
- Unit:
Factor
- Example:
nan
- Restrictions:
Real number between 0 and 1
- Default:
0
specific_costs¶
- Definition_Short:
Specific investment costs of the asset related to the installed capacity (CAPEX)
- Type:
numeric
- Unit:
€/:unit:
- Example:
1000
- Restrictions:
nan
- Default:
1000
specific_costs_om¶
- Definition_Short:
Specific operational and maintenance costs of the asset related to the installed capacity (OPEX_fix)
- Type:
numeric
- Unit:
€/(:unit:*a)
- Example:
10
- Restrictions:
nan
- Default:
10
start_date¶
- Definition_Short:
Date and time when the simulation starts with the first step
- Definition_Long:
This date will be used for the results graphs as well as the timeseries upload.
- Type:
str
- Unit:
nan
- Example:
2018-01-01 00:00:00
- Restrictions:
Acceptable format is YYYY-MM-DD HH:MM:SS
- Default:
nan
storage_filename¶
- Definition_Short:
Name of a csv file containing the properties of a storage component
- Type:
str
- Unit:
nan
- Example:
storage_01.csv
- Restrictions:
Follows the convention of ‘storage_xx.csv’ where ‘xx’ is a number. This file must be placed in a folder named “csv_elements” inside your input folder.
- Default:
nan
tax¶
- Definition_Short:
Tax factor
- Type:
numeric
- Unit:
Factor
- Example:
0
- Restrictions:
Between 0 and 1
- Default:
0
timestep¶
- Definition_Short:
Length of the time steps
- Type:
numeric
- Unit:
nan
- Example:
60
- Restrictions:
Can only be 60 minutes at the moment
- Default:
60
type_oemof¶
- Definition_Short:
Input the type of OEMOF component
- Definition_Long:
A photovoltaic plant would be a source, a solar inverter would be a transformer, etc. The type_oemof will later on be determined through the EPA.
- Type:
str
- Unit:
nan
- Example:
sink
- Restrictions:
sink or source or one of the other component classes of OEMOF.
- Default:
nan
unit¶
- Definition_Short:
Unit associated with the capacity of the component
- Type:
str
- Unit:
nan
- Example:
Storage could have units like kW or kWh, transformer station could have kVA, and so on.
- Restrictions:
Appropriate scientific unit
- Default:
kW
beta¶
- Definition_Short:
Power loss index for CHPs, usually known as beta coefficient
- Definition_Long:
0.6
- Type:
factor
- Unit:
beta
- Example:
Between 0 and 1
- Restrictions:
numeric
- Default:
0