Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add facades CommodityGHG and ConversionGHG #180

Merged
merged 19 commits into from
Aug 22, 2024
Merged

Add facades CommodityGHG and ConversionGHG #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
a2d1032
Typos
SabineHaas Aug 9, 2024
dc4c864
Add facade CommodityGHG and ConversionGHG
SabineHaas Aug 9, 2024
b9b3f6a
Add tests for facades CommodityGHG and ConversionGHG
SabineHaas Aug 9, 2024
06c8d13
Add CommodityGHG and ConversionGHG to typemap
SabineHaas Aug 9, 2024
0271cb2
Add lp files for tests
SabineHaas Aug 9, 2024
8780416
Add example data for CommodityGHG and ConversionGHG facades
SabineHaas Aug 9, 2024
61ad5c5
Add to changelog and authors
SabineHaas Aug 9, 2024
d7b58a2
Compute GHG
SabineHaas Aug 9, 2024
dd1f923
Adapt commodityGHG test, use negative emissions
SabineHaas Aug 12, 2024
a11c2e5
GHG flow commodityGHG bidirectional to allow negative emission factors
SabineHaas Aug 12, 2024
3937ee9
Delete pass statement
SabineHaas Aug 12, 2024
18e0b4d
Adapt values of test files
SabineHaas Aug 12, 2024
7cc9e31
Mention "green house gases" in docstrings for connection to class name
SabineHaas Aug 13, 2024
322a9aa
Add new facades to documentation
SabineHaas Aug 13, 2024
6e01808
Skip test_examples_datapackages_scripts_infer for GHG facades
SabineHaas Aug 13, 2024
056e0d4
Adapt test lp file to bidirectional flow of commodityGHG
SabineHaas Aug 14, 2024
c0f2038
Rename variable to avoid missunderstandings
SabineHaas Aug 14, 2024
51bb272
Add warnings for missing emission bus oder emission factor
SabineHaas Aug 14, 2024
3c6bc94
Merge branch 'dev' into feature/ghg_facades
SabineHaas Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Authors
* Julian Endres
* Felix Maurer
* Pierre-Francois Duc
* Sabine Haas
1 change: 1 addition & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Unreleased

Features
* Improve the function to infer package metadata `#173 <https://github.com/oemof/oemof-tabular/pull/173>`_
* Add facades `CommodityGHG` and `ConversionGHG` to enable multiple output flows (emissions) `#180 <https://github.com/oemof/oemof-tabular/pull/180>`_

Fixes

Expand Down
4 changes: 3 additions & 1 deletion docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,11 @@ Currently we provide the following facades:
* :py:class:`~oemof.tabular.facades.ExtractionTurbine`
* :py:class:`~oemof.tabular.facades.Commodity`
* :py:class:`~oemof.tabular.facades.Conversion`
* :py:class:`~oemof.tabular.facades.Load`.
* :py:class:`~oemof.tabular.facades.Load`
* :py:class:`~oemof.tabular.facades.Link`
* :py:class:`~oemof.tabular.facades.Excess`
* :py:class:`~oemof.tabular.facades.CommodityGHG`: a commodity unit with green house gases
* :py:class:`~oemof.tabular.facades.ConversionGHG`: a conversion unit with green house gases.

These can be mixed with all oemof solph classes if your are scripting.

Expand Down
5 changes: 5 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Green house gases (GHG) example for oemof-tabular

Run `scripts/infer.py` from the datapackage root directory to add the
meta data file `datapackage.json` after updating the resources of the
datapackage.
6 changes: 6 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/elements/bus.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name;type;balanced
co2;bus;false
ch4;bus;false
n2o;bus;false
el_bus;bus;true
gas_bus;bus;true
3 changes: 3 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/elements/commodityGHG_import.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
name;type;carrier;amount;bus;emission_bus_0;marginal_cost;output_parameters;emission_factor_co2
green_gas_import;commodity_ghg;gas;300;gas_bus;co2;20;{"max": [1, 1, 1]};-56
fossile_gas_import;commodity_ghg;gas;200;gas_bus;co2;10;{"max": [1, 0, 0]};56
2 changes: 2 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/elements/conversionGHG.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
name;type;carrier;tech;capacity;from_bus;to_bus;emission_bus_0;emission_bus_1;emission_bus_2;marginal_cost;efficiency;emission_factor_co2;emission_factor_ch4;emission_factor_n2o
gtGHG;conversion_ghg;electricity;gt;300;gas_bus;el_bus;co2;ch4;n2o;10;0.5;56;0.4;0.017
2 changes: 2 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/elements/excess.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
name;type;bus;capacity
gas_excess;excess;gas_bus;1000000000
2 changes: 2 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/elements/load.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
name;amount;profile;type;bus
demand0;100;electricity-load-profile;load;el_bus
2 changes: 2 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/elements/shortage.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
name;type;carrier;tech;bus;capacity;marginal_cost
el_shortage;shortage;electricity;shortage;el_bus;100000000;100000
4 changes: 4 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/data/sequences/load_profile.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
timeindex,electricity-load-profile
2011-01-01T00:00:00Z,1
2011-01-01T01:00:00Z,0.5
2011-01-01T02:00:00Z,0.1
325 changes: 325 additions & 0 deletions src/oemof/tabular/examples/datapackages/GHG/datapackage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
{
"profile": "tabular-data-package",
"name": "GHG-test",
"oemof_tabular_version": "0.0.6dev",
"resources": [
{
"path": "data/elements/bus.csv",
"profile": "tabular-data-resource",
"name": "bus",
"format": "csv",
"mediatype": "text/csv",
"encoding": "utf-8",
"schema": {
"fields": [
{
"name": "name",
"type": "string",
"format": "default"
},
{
"name": "type",
"type": "string",
"format": "default"
},
{
"name": "balanced",
"type": "boolean",
"format": "default"
}
],
"missingValues": [
""
],
"primaryKey": "name",
"foreignKeys": []
}
},
{
"path": "data/elements/conversionGHG.csv",
"profile": "tabular-data-resource",
"name": "conversionGHG",
"format": "csv",
"mediatype": "text/csv",
"encoding": "utf-8",
"schema": {
"fields": [
{
"name": "name",
"type": "string",
"format": "default"
},
{
"name": "type",
"type": "string",
"format": "default"
},
{
"name": "carrier",
"type": "string",
"format": "default"
},
{
"name": "tech",
"type": "string",
"format": "default"
},
{
"name": "capacity",
"type": "integer",
"format": "default"
},
{
"name": "from_bus",
"type": "string",
"format": "default"
},
{
"name": "to_bus",
"type": "string",
"format": "default"
},
{
"name": "emission_bus_0",
"type": "string",
"format": "default"
},
{
"name": "emission_bus_1",
"type": "string",
"format": "default"
},
{
"name": "emission_bus_2",
"type": "string",
"format": "default"
},
{
"name": "marginal_cost",
"type": "integer",
"format": "default"
},
{
"name": "efficiency",
"type": "number",
"format": "default"
},
{
"name": "emission_factor_co2",
"type": "number",
"format": "default"
},
{
"name": "emission_factor_ch4",
"type": "number",
"format": "default"
},
{
"name": "emission_factor_n2o",
"type": "number",
"format": "default"
}
],
"foreignKeys": [
{
"fields": "from_bus",
"reference": {
"resource": "bus",
"fields": "name"
}
},
{
"fields": "to_bus",
"reference": {
"resource": "bus",
"fields": "name"
}
},
{
"fields": "emission_bus_0",
"reference": {
"resource": "bus",
"fields": "name"
}
},
{
"fields": "emission_bus_1",
"reference": {
"resource": "bus",
"fields": "name"
}
},
{
"fields": "emission_bus_2",
"reference": {
"resource": "bus",
"fields": "name"
}
}
],
"missingValues": [
""
],
"primaryKey": "name"
}
},
{
"path": "data/elements/commodityGHG_import.csv",
"profile": "tabular-data-resource",
"name": "commodityGHG_import",
"format": "csv",
"mediatype": "text/csv",
"encoding": "utf-8",
"schema": {
"fields": [
{
"name": "name",
"type": "string",
"format": "default"
},
{
"name": "type",
"type": "string",
"format": "default"
},
{
"name": "carrier",
"type": "string",
"format": "default"
},
{
"name": "amount",
"type": "integer",
"format": "default"
},
{
"name": "bus",
"type": "string",
"format": "default"
},
{
"name": "emission_bus_0",
"type": "string",
"format": "default"
},
{
"name": "marginal_cost",
"type": "integer",
"format": "default"
},
{
"name": "output_parameters",
"type": "object",
"format": "default"
},
{
"name": "emission_factor_co2",
"type": "number",
"format": "default"
}
],
"missingValues": [
""
],
"primaryKey": "name",
"foreignKeys": [
{
"fields": "bus",
"reference": {
"resource": "bus",
"fields": "name"
}
},
{
"fields": "emission_bus_0",
"reference": {
"resource": "bus",
"fields": "name"
}
}
]
}
},
{
"path": "data/elements/load.csv",
"profile": "tabular-data-resource",
"name": "load",
"format": "csv",
"mediatype": "text/csv",
"encoding": "utf-8",
"schema": {
"fields": [
{
"name": "name",
"type": "string",
"format": "default"
},
{
"name": "amount",
"type": "integer",
"format": "default"
},
{
"name": "profile",
"type": "string",
"format": "default"
},
{
"name": "type",
"type": "string",
"format": "default"
},
{
"name": "bus",
"type": "string",
"format": "default"
}
],
"missingValues": [
""
],
"primaryKey": "name",
"foreignKeys": [
{
"fields": "bus",
"reference": {
"resource": "bus",
"fields": "name"
}
},
{
"fields": "profile",
"reference": {
"resource": "load_profile"
}
}
]
}
},
{
"path": "data/sequences/load_profile.csv",
"profile": "tabular-data-resource",
"name": "load_profile",
"format": "csv",
"mediatype": "text/csv",
"encoding": "utf-8",
"schema": {
"fields": [
{
"name": "timeindex",
"type": "datetime",
"format": "default"
},
{
"name": "electricity-load-profile",
"type": "number",
"format": "default"
}
],
"missingValues": [
""
]
}
}
]
}
Loading
Loading