-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
128 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 23 additions & 0 deletions
23
docs/docs/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/FACTOR.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
# FACTOR | ||
|
||
[FUEL_TYPES](/about/references/keywords_tree/FUEL_TYPES/index.md) / | ||
[EMISSIONS](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/index.md) / | ||
[FACTOR](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/FACTOR.md) | ||
|
||
## Description | ||
`FACTOR` is a single value (kg/Sm<sup>3</sup>) used to define the emissions in kg per Sm<sup>3</sup> | ||
of the fuel gas used on the installation. That is, how many kilograms of e.g. CO<sub>2</sub> are emitted per | ||
Sm<sup>3</sup> of fuel gas burnt. | ||
|
||
Say your fuel emits 2.5 kg CO<sub>2</sub> per Sm<sup>3</sup> of burned fuel, you can model this like | ||
|
||
~~~~~~~~yaml | ||
FUEL_TYPES: | ||
- NAME: my_fuel | ||
EMISSIONS: | ||
- NAME: CO2 | ||
FACTOR: 2.5 # [kg/Sm3] | ||
~~~~~~~~ |
26 changes: 26 additions & 0 deletions
26
docs/docs/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/NAME.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
# NAME | ||
|
||
[FUEL_TYPES](/about/references/keywords_tree/FUEL_TYPES/index.md) / | ||
[EMISSIONS](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/index.md) / | ||
[NAME](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/NAME.md) | ||
|
||
## Description | ||
Emission name. | ||
|
||
### Format | ||
~~~~~~~~yaml | ||
EMISSIONS: | ||
- NAME: <name of emission> | ||
... | ||
~~~~~~~~ | ||
|
||
### Example | ||
|
||
~~~~~~~~yaml | ||
EMISSIONS: | ||
- NAME: CO2 | ||
... | ||
~~~~~~~~ |
38 changes: 38 additions & 0 deletions
38
docs/docs/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
# EMISSIONS | ||
|
||
[FUEL_TYPES](/about/references/keywords_tree/FUEL_TYPES/index.md) / | ||
[EMISSIONS](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/index.md) | ||
|
||
|
||
|
||
| Required | Child of | Children/Options | | ||
|------------|---------------------------|------------------------------------| | ||
| No | `FUEL_TYPES` | `FACTOR` <br /> `NAME` | | ||
|
||
|
||
## Description | ||
In [EMISSIONS](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/index.md) one or more emissions related to the use of fuel is specified as | ||
a list. Each emission entry is **required** to have a [NAME](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/NAME.md) | ||
and a [FACTOR](/about/references/keywords_tree/FUEL_TYPES/EMISSIONS/FACTOR.md). | ||
|
||
|
||
## Format | ||
~~~~~~~~yaml | ||
EMISSIONS: | ||
- NAME: <name> | ||
FACTOR: <factor> | ||
~~~~~~~~ | ||
|
||
## Example | ||
For example, if you want to add CO<sub>2</sub> emissions associated to the usage of a [FUEL_TYPES](/about/references/keywords_tree/FUEL_TYPES/index.md) | ||
you write the following: | ||
|
||
~~~~~~~~yaml | ||
EMISSIONS: | ||
- NAME: CO2 | ||
FACTOR: 2.5 # [kg/Sm3] | ||
~~~~~~~~ | ||
|
25 changes: 25 additions & 0 deletions
25
docs/docs/about/references/keywords_tree/FUEL_TYPES/NAME.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
# NAME | ||
|
||
[FUEL_TYPES](/about/references/keywords_tree/FUEL_TYPES/index.md) / | ||
[NAME](/about/references/keywords_tree/FUEL_TYPES/NAME.md) | ||
|
||
## Description | ||
Fuel type name. | ||
|
||
### Format | ||
~~~~~~~~yaml | ||
FUEL_TYPES: | ||
- NAME: <name of fuel, for reference> | ||
... | ||
~~~~~~~~ | ||
|
||
### Example | ||
|
||
~~~~~~~~yaml | ||
FUEL_TYPES: | ||
- NAME: some_fuel_name | ||
... | ||
~~~~~~~~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters