Changes

Page history
Update Dictionary authored by Touko Kumpulainen's avatar Touko Kumpulainen
Show whitespace changes
Inline Side-by-side
Features/Dictionary.md
View page @ 0bb2113f
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
title: Dictionary title: Dictionary
--- ---
# Parameter Dictionary # Parameter Dictionary
This page documents the main parameters used to configure a Backbone model. These include: This page documents the main parameters used to configure a Backbone model. These include:
...@@ -564,8 +565,8 @@ Assigns a fixed economic value to stored energy at the node level. This can infl ...@@ -564,8 +565,8 @@ Assigns a fixed economic value to stored energy at the node level. This can infl
| Parameter | Description | Type | Unit | Allowed range | Default | | Parameter | Description | Type | Unit | Allowed range | Default |
|--------------|--------------------------------------------------------------------------------|-------|--------|---------------|---------| |--------------|--------------------------------------------------------------------------------|-------|--------|---------------|---------|
| GRID | Grid in which the storage node is located. | text | — | — | — | | GRID | Grid in which the storage node is located. | string | — | — | — |
| NODE | Node with a state variable (`useState = 1`). | text | — | — | — | | NODE | Node with a state variable (`useState = 1`). | string | — | — | — |
| storageValue | Constant marginal value of energy stored at the end of a timestep. | float | €/unit | — | empty | | storageValue | Constant marginal value of energy stored at the end of a timestep. | float | €/unit | — | empty |
...@@ -576,7 +577,7 @@ These can be assigned to units or groups for emission accounting, constraints, o ...@@ -576,7 +577,7 @@ These can be assigned to units or groups for emission accounting, constraints, o
| Parameter | Description | Type | Unit | Allowed range | Default | | Parameter | Description | Type | Unit | Allowed range | Default |
|-----------|--------------------------------------|-------|------|-----------------|---------| |-----------|--------------------------------------|-------|------|-----------------|---------|
| emission | Lists all emission types in the model | text | — | unique strings | none | | emission | Lists all emission types in the model | string | — | unique strings | none |
### `p_nEmission` ### `p_nEmission`
...@@ -587,8 +588,8 @@ Each row links a node to an emission type and specifies how much of the emission ...@@ -587,8 +588,8 @@ Each row links a node to an emission type and specifies how much of the emission
| Parameter | Description | Type | Unit | Allowed range | Default | | Parameter | Description | Type | Unit | Allowed range | Default |
|------------------|----------------------------------------------------------------|-------|-----------|---------------|---------| |------------------|----------------------------------------------------------------|-------|-----------|---------------|---------|
| NODE | Node associated with the emission (e.g., fuel node). | text | — | must exist in `node` sheet | — | | NODE | Node associated with the emission (e.g., fuel node). | string | — | must exist in `node` sheet | — |
| emission | Emission type (e.g., `CO2`, `SO2`). | text | — | must exist in `emission` sheet | — | | emission | Emission type (e.g., `CO2`, `SO2`). | string | — | must exist in `emission` sheet | — |
| emission content | Emissions in tonnes per MWh of energy used (refers to input). | float | t/MWh | ≥ 0 | 0 | | emission content | Emissions in tonnes per MWh of energy used (refers to input). | float | t/MWh | ≥ 0 | 0 |
> 📘 Emission costs can be added using [`ts_emissionPrice`](#time-series-input-sheets). > 📘 Emission costs can be added using [`ts_emissionPrice`](#time-series-input-sheets).
...@@ -605,7 +606,7 @@ This section documents all input sheets related to reserve modeling in Backbone, ...@@ -605,7 +606,7 @@ This section documents all input sheets related to reserve modeling in Backbone,
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|--------------------------------------------------------------|------|------|------------------------------------------|---------| |-----------|--------------------------------------------------------------|------|------|------------------------------------------|---------|
| restype | Name of each reserve product (e.g., `primary`, `FFR`). | text | — | unique string | — | | restype | Name of each reserve product (e.g., `primary`, `FFR`). | string | — | unique string | — |
--- ---
...@@ -613,8 +614,8 @@ This section documents all input sheets related to reserve modeling in Backbone, ...@@ -613,8 +614,8 @@ This section documents all input sheets related to reserve modeling in Backbone,
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|-----------------------------------------------------------------------------|------|------|------------------------------------------|---------| |-----------|-----------------------------------------------------------------------------|------|------|------------------------------------------|---------|
| restype | Name of reserve type. | text | — | must exist in `restype` sheet | — | | restype | Name of reserve type. | string | — | must exist in `restype` sheet | — |
| up_down | Direction of reserve provision (separate row for each if both directions). | text | — | `up`, `down` | — | | up_down | Direction of reserve provision (separate row for each if both directions). | string | — | `up`, `down` | — |
--- ---
...@@ -622,7 +623,7 @@ This section documents all input sheets related to reserve modeling in Backbone, ...@@ -622,7 +623,7 @@ This section documents all input sheets related to reserve modeling in Backbone,
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|--------------------------------------------------------------------------------------|------|------|------------------------------------------|---------| |-----------|--------------------------------------------------------------------------------------|------|------|------------------------------------------|---------|
| restype | Reserve type whose unused capacity may be released as actual generation. | text | — | must exist in `restype` sheet | — | | restype | Reserve type whose unused capacity may be released as actual generation. | string | — | must exist in `restype` sheet | — |
--- ---
...@@ -630,7 +631,7 @@ This section documents all input sheets related to reserve modeling in Backbone, ...@@ -630,7 +631,7 @@ This section documents all input sheets related to reserve modeling in Backbone,
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|--------------------------------------------------------------------------------------|------|------|------------------------------------------|---------| |-----------|--------------------------------------------------------------------------------------|------|------|------------------------------------------|---------|
| restype | Reserve type that contributes to inertia (if inertia modeling is enabled). | text | — | must exist in `restype` sheet | — | | restype | Reserve type that contributes to inertia (if inertia modeling is enabled). | string | — | must exist in `restype` sheet | — |
--- ---
...@@ -660,10 +661,10 @@ Defines group-specific reserve policies. ...@@ -660,10 +661,10 @@ Defines group-specific reserve policies.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|--------------|-------------------------------------------------------------|-------|------|------------------------------------|---------| |--------------|-------------------------------------------------------------|-------|------|------------------------------------|---------|
| group | Reserve group name. | text | — | must exist in `group` sheet | — | | group | Reserve group name. | string | — | must exist in `group` sheet | — |
| restype | Reserve type. | text | — | must exist in `restype` sheet | — | | restype | Reserve type. | string | — | must exist in `restype` sheet | — |
| up_down | Direction of reserve provision. | text | — | `up`, `down` | — | | up_down | Direction of reserve provision. | string | — | `up`, `down` | — |
| param_policy | Policy applied (e.g., `LossOfTrans` for N-1 security). | text | — | must exist in `param_policy` sheet | — | | param_policy | Policy applied (e.g., `LossOfTrans` for N-1 security). | string | — | must exist in `param_policy` sheet | — |
--- ---
...@@ -673,11 +674,11 @@ Links policy logic across groups (e.g., to limit VRE-based reserves). ...@@ -673,11 +674,11 @@ Links policy logic across groups (e.g., to limit VRE-based reserves).
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|--------------|--------------------------------------------------------------------|--------|------|------------------------------------|---------| |--------------|--------------------------------------------------------------------|--------|------|------------------------------------|---------|
| group | Source group. | text | — | must exist in `group` sheet | — | | group | Source group. | string | — | must exist in `group` sheet | — |
| restype | Reserve type. | text | — | must exist in `restype` sheet | — | | restype | Reserve type. | string | — | must exist in `restype` sheet | — |
| up_down | Direction. | text | — | `up`, `down` | — | | up_down | Direction. | string | — | `up`, `down` | — |
| group | Target group (receiving reserves). | text | — | must exist in `group` sheet | — | | group | Target group (receiving reserves). | string | — | must exist in `group` sheet | — |
| param_policy | Policy name (e.g., `ReserveShareMax`). | text | — | must exist in `param_policy` sheet | — | | param_policy | Policy name (e.g., `ReserveShareMax`). | string | — | must exist in `param_policy` sheet | — |
| value | Numeric threshold (e.g., max share = 0,9). | float | — | ≥ 0 | empty | | value | Numeric threshold (e.g., max share = 0,9). | float | — | ≥ 0 | empty |
--- ---
...@@ -705,11 +706,11 @@ Allows reserves to be provided from one node to cover requirements at another no ...@@ -705,11 +706,11 @@ Allows reserves to be provided from one node to cover requirements at another no
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|--------------------|-------|------|--------------------------|---------| |-----------|--------------------|-------|------|--------------------------|---------|
| GRID | Grid name. | text | — | must exist in `grid` sheet| — | | GRID | Grid name. | string | — | must exist in `grid` sheet| — |
| NODE | Source node. | text | — | must exist in `node` sheet| — | | NODE | Source node. | string | — | must exist in `node` sheet| — |
| NODE | Target node. | text | — | must exist in `node` sheet| — | | NODE | Target node. | string | — | must exist in `node` sheet| — |
| restype | Reserve type. | text | — | must exist in `restype` sheet | — | | restype | Reserve type. | string | — | must exist in `restype` sheet | — |
| up_down | Direction. | text | — | `up`, `down` | — | | up_down | Direction. | string | — | `up`, `down` | — |
--- ---
...@@ -719,12 +720,12 @@ Defines substitution between reserve types (e.g., tertiary → primary). ...@@ -719,12 +720,12 @@ Defines substitution between reserve types (e.g., tertiary → primary).
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|--------------------------------------------------------------|--------|----------|-------------------------------------|---------| |-----------|--------------------------------------------------------------|--------|----------|-------------------------------------|---------|
| GRID | Grid name. | text | — | must exist in `grid` sheet | — | | GRID | Grid name. | string | — | must exist in `grid` sheet | — |
| NODE | Node name. | text | — | must exist in `node` sheet | — | | NODE | Node name. | string | — | must exist in `node` sheet | — |
| UNIT | Unit name. | text | — | must exist in `unit` sheet | — | | UNIT | Unit name. | string | — | must exist in `unit` sheet | — |
| restype | Source reserve type being used as a substitute. | text | — | must exist in `restype` sheet | — | | restype | Source reserve type being used as a substitute. | string | — | must exist in `restype` sheet | — |
| up_down | Direction. | text | — | `up`, `down` | — | | up_down | Direction. | string | — | `up`, `down` | — |
| restype | Target reserve type requirement being fulfilled. | text | — | must exist in `restype` sheet | — | | restype | Target reserve type requirement being fulfilled. | string | — | must exist in `restype` sheet | — |
| value | Share of the source reserve counted toward the target (0–1). | float | fraction | 0–1 | empty | | value | Share of the source reserve counted toward the target (0–1). | float | fraction | 0–1 | empty |
--- ---
...@@ -735,7 +736,7 @@ Lists units that are considered at risk of tripping. Their infeed must be covere ...@@ -735,7 +736,7 @@ Lists units that are considered at risk of tripping. Their infeed must be covere
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|----------------------------------------------|-------|------|------------------------|---------| |-----------|----------------------------------------------|-------|------|------------------------|---------|
| unitFail | Units whose output may suddenly drop. | text | — | must exist in `unit` sheet | — | | unitFail | Units whose output may suddenly drop. | string | — | must exist in `unit` sheet | — |
...@@ -759,7 +760,7 @@ Below are the Excel input sheets related to groups. ...@@ -759,7 +760,7 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|----------------------------------------------------------------|------|------|------------------------|---------| |-----------|----------------------------------------------------------------|------|------|------------------------|---------|
| GROUP | Name of a group used across other group-related sheets. | text | — | unique string | — | | GROUP | Name of a group used across other group-related sheets. | string | — | unique string | — |
--- ---
...@@ -767,8 +768,8 @@ Below are the Excel input sheets related to groups. ...@@ -767,8 +768,8 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|--------------------------------------------|------|------|--------------------------------|---------| |-----------|--------------------------------------------|------|------|--------------------------------|---------|
| UNIT | Unit name to assign to a group. | text | — | must exist in `unit` sheet | — | | UNIT | Unit name to assign to a group. | string | — | must exist in `unit` sheet | — |
| GROUP | Group to which the unit belongs. | text | — | must exist in `group` sheet | — | | GROUP | Group to which the unit belongs. | string | — | must exist in `group` sheet | — |
--- ---
...@@ -776,10 +777,10 @@ Below are the Excel input sheets related to groups. ...@@ -776,10 +777,10 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|---------------------------------------------------|------|------|--------------------------------|---------| |-----------|---------------------------------------------------|------|------|--------------------------------|---------|
| GRID | Grid where the unit is located. | text | — | must exist in `grid` sheet | — | | GRID | Grid where the unit is located. | string | — | must exist in `grid` sheet | — |
| NODE | Node where the unit is connected. | text | — | must exist in `node` sheet | — | | NODE | Node where the unit is connected. | string | — | must exist in `node` sheet | — |
| UNIT | Unit to assign to the group. | text | — | must exist in `unit` sheet | — | | UNIT | Unit to assign to the group. | string | — | must exist in `unit` sheet | — |
| GROUP | Group name (for reserve coordination or policy). | text | — | must exist in `group` sheet | — | | GROUP | Group name (for reserve coordination or policy). | string | — | must exist in `group` sheet | — |
--- ---
...@@ -787,10 +788,10 @@ Below are the Excel input sheets related to groups. ...@@ -787,10 +788,10 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|----------------------------------------------------|------|------|--------------------------------|---------| |-----------|----------------------------------------------------|------|------|--------------------------------|---------|
| GRID | Grid containing the transfer link. | text | — | must exist in `grid` sheet | — | | GRID | Grid containing the transfer link. | string | — | must exist in `grid` sheet | — |
| NODE | From-node of the transfer link. | text | — | must exist in `node` sheet | — | | NODE | From-node of the transfer link. | string | — | must exist in `node` sheet | — |
| NODE | To-node of the transfer link. | text | — | must exist in `node` sheet | — | | NODE | To-node of the transfer link. | string | — | must exist in `node` sheet | — |
| GROUP | Group that includes this transfer link. | text | — | must exist in `group` sheet | — | | GROUP | Group that includes this transfer link. | string | — | must exist in `group` sheet | — |
--- ---
...@@ -798,9 +799,9 @@ Below are the Excel input sheets related to groups. ...@@ -798,9 +799,9 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|------------------------------------------------------|------|------|--------------------------------|---------| |-----------|------------------------------------------------------|------|------|--------------------------------|---------|
| GRID | Grid containing the node. | text | — | must exist in `grid` sheet | — | | GRID | Grid containing the node. | string | — | must exist in `grid` sheet | — |
| NODE | Node to include in the group. | text | — | must exist in `node` sheet | — | | NODE | Node to include in the group. | string | — | must exist in `node` sheet | — |
| GROUP | Group name (for applying node-level group policies). | text | — | must exist in `group` sheet | — | | GROUP | Group name (for applying node-level group policies). | string | — | must exist in `group` sheet | — |
--- ---
...@@ -808,8 +809,8 @@ Below are the Excel input sheets related to groups. ...@@ -808,8 +809,8 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-----------|------------------------------------------------------|------|------|----------------------------------|---------| |-----------|------------------------------------------------------|------|------|----------------------------------|---------|
| SAMPLE | Sample to include in the group. | text | — | must exist in `sample` registry | — | | SAMPLE | Sample to include in the group. | string | — | must exist in `sample` registry | — |
| GROUP | Group name (for sample-level policies or selection). | text | — | must exist in `group` sheet | — | | GROUP | Group name (for sample-level policies or selection). | string | — | must exist in `group` sheet | — |
--- ---
...@@ -817,8 +818,8 @@ Below are the Excel input sheets related to groups. ...@@ -817,8 +818,8 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|---------------|-----------------------------------------------------------------------------------|-------|------|---------------------------------|---------| |---------------|-----------------------------------------------------------------------------------|-------|------|---------------------------------|---------|
| GROUP | Group to which the policy applies. | text | — | must exist in `group` sheet | — | | GROUP | Group to which the policy applies. | string | — | must exist in `group` sheet | — |
| PARAM_POLICY | Name of the group-level policy (e.g., `ROCOF`, `constrainedOnlineTotalMax`). | text | — | must exist in `param_policy` sheet | — | | PARAM_POLICY | Name of the group-level policy (e.g., `ROCOF`, `constrainedOnlineTotalMax`). | string | — | must exist in `param_policy` sheet | — |
| value | Value of the policy parameter (meaning depends on `PARAM_POLICY`). | float | — | ≥ 0 or per policy rules | empty | | value | Value of the policy parameter (meaning depends on `PARAM_POLICY`). | float | — | ≥ 0 or per policy rules | empty |
--- ---
...@@ -827,9 +828,9 @@ Below are the Excel input sheets related to groups. ...@@ -827,9 +828,9 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|---------------|---------------------------------------------------------------------|-------|------|---------------------------------|---------| |---------------|---------------------------------------------------------------------|-------|------|---------------------------------|---------|
| GROUP | Group to which the policy applies. | text | — | must exist in `group` sheet | — | | GROUP | Group to which the policy applies. | string | — | must exist in `group` sheet | — |
| PARAM_POLICY | Policy name (e.g., `constrainedOnlineMultiplier`). | text | — | must exist in `param_policy` sheet | — | | PARAM_POLICY | Policy name (e.g., `constrainedOnlineMultiplier`). | string | — | must exist in `param_policy` sheet | — |
| UNIT | Unit the policy targets within the group. | text | — | must exist in `unit` sheet | — | | UNIT | Unit the policy targets within the group. | string | — | must exist in `unit` sheet | — |
| value | Policy value (e.g., multiplier or constraint setting). | float | — | ≥ 0 or per policy rules | empty | | value | Policy value (e.g., multiplier or constraint setting). | float | — | ≥ 0 or per policy rules | empty |
--- ---
...@@ -838,9 +839,9 @@ Below are the Excel input sheets related to groups. ...@@ -838,9 +839,9 @@ Below are the Excel input sheets related to groups.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|---------------|------------------------------------------------------------------------|-------|------|---------------------------------|---------| |---------------|------------------------------------------------------------------------|-------|------|---------------------------------|---------|
| GROUP | Group to which the emission policy applies. | text | — | must exist in `group` sheet | — | | GROUP | Group to which the emission policy applies. | string | — | must exist in `group` sheet | — |
| PARAM_POLICY | Emission-related group policy (e.g., `taxCap`). | text | — | must exist in `param_policy` sheet | — | | PARAM_POLICY | Emission-related group policy (e.g., `taxCap`). | string | — | must exist in `param_policy` sheet | — |
| EMISSION | Emission name targeted by the policy (e.g., `CO2`). | text | — | must exist in `emission` sheet | — | | EMISSION | Emission name targeted by the policy (e.g., `CO2`). | string | — | must exist in `emission` sheet | — |
| value | Policy value (e.g., cap or price multiplier). | float | — | ≥ 0 or per policy rules | empty | | value | Policy value (e.g., cap or price multiplier). | float | — | ≥ 0 or per policy rules | empty |
...@@ -877,7 +878,7 @@ Used in investment simulations to limit when investments can occur. ...@@ -877,7 +878,7 @@ Used in investment simulations to limit when investments can occur.
| Parameter | Description | Type | Unit | Allowed range / values | Default | | Parameter | Description | Type | Unit | Allowed range / values | Default |
|-------------|------------------------------------------------------------------------|-------|------|----------------------------|---------| |-------------|------------------------------------------------------------------------|-------|------|----------------------------|---------|
| TIME_INDEX | Time step when investment decisions are permitted (e.g., `t000001`). | text | — | must exist in model's time index | — | | TIME_INDEX | Time step when investment decisions are permitted (e.g., `t000001`). | string | — | must exist in model's time index | — |
> 🔗 Related: See the [Investment Modelling](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Features/Investment-Modelling) page for how `t_invest` is used in time sampling for investment decisions. > 🔗 Related: See the [Investment Modelling](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Features/Investment-Modelling) page for how `t_invest` is used in time sampling for investment decisions.
... ...
......

This system is mainly used for VTT projects and partners in those projects. Default permission does not allow user to create projects / groups. If you are VTT person, please contact Kimmo Ahola for getting permissions.