Skip to content

Commit 6129fa8

Browse files
sebastian-petersebastian-peter
authored
Merge pull request #998 from ie3-institute/pp/#825-enhance-documentation-for-csv-timeseries
Pp/#825 enhance documentation for csv timeseries
2 parents c87412a + 0881c78 commit 6129fa8

File tree

2 files changed

+153
-57
lines changed

2 files changed

+153
-57
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515
- Added separate field for maximum power limit for DC to evtype [#876](https://github.com/ie3-institute/PowerSystemDataModel/issues/876)
1616
- Added test for invalid input data in `CsvRawGridSource` [#1021](https://github.com/ie3-institute/PowerSystemDataModel/issues/1021)
1717
- Added `CsvThermalGridSource` [#1009](https://github.com/ie3-institute/PowerSystemDataModel/issues/1009)
18+
- Enhance documentation for CSV timeseries [#825](https://github.com/ie3-institute/PowerSystemDataModel/issues/825)
1819

1920
### Fixed
2021
- Fixed Couchbase integration tests that randomly failed [#755](https://github.com/ie3-institute/PowerSystemDataModel/issues/755)

‎docs/readthedocs/io/csvfiles.md‎

Lines changed: 152 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -24,80 +24,175 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers
2424

2525
### Input
2626

27-
| Model | File Name |
28-
|:----------------------------------|:------------------------------------------------------------------------------------------|
29-
| operator | *prefix_* operator_input *_suffix* |
30-
| node | *prefix_* node_input *_suffix* |
31-
| line | *prefix_* line_input *_suffix* <br> *prefix_* line_type_input *_suffix* |
32-
| switch | *prefix_* switch_input *_suffix* |
33-
| two winding transformer | *prefix_* transformer2w_input *_suffix* <br> *prefix_* transformer2w_type_input *_suffix* |
34-
| three winding transformer | *prefix_* transformer3w_input *_suffix* <br> *prefix_* transformer3w_type_input *_suffix* |
35-
| measurement unit | *prefix_* measurement_unit_input *_suffix* |
36-
| biomass plant | *prefix_* bm_input *_suffix* <br> *prefix_* bm_type_input *_suffix* |
37-
| combined heat and power plant | *prefix_* chp_input *_suffix* <br> *prefix_* chp_type_input *_suffix* |
38-
| electric vehicle | *prefix_* ev_input *_suffix* <br> *prefix_* ev_type_input *_suffix* |
39-
| electric vehicle charging station | *prefix_* evcs_input *_suffix* |
40-
| fixed feed in facility | *prefix_* fixed_feed_in_input *_suffix* |
41-
| heat pump | *prefix_* hp_input *_suffix* <br> *prefix_* hp_type_input *_suffix* |
42-
| load | *prefix_* load_input *_suffix* |
43-
| photovoltaic power plant | *prefix_* pc_input *_suffix* |
44-
| electrical energy storage | *prefix_* storage_input *_suffix* <br> *prefix_* storage_type_input *_suffix* |
45-
| wind energy converter | *prefix_* wec_input *_suffix* <br> *prefix_* wec_type_input *_suffix* |
46-
| schematic node graphic | *prefix_* node_graphic_input *_suffix* |
47-
| schematic line graphic | *prefix_* line_graphic_input *_suffix* |
27+
```{eval-rst}
28+
.. list-table::
29+
:widths: auto
30+
:header-rows: 1
31+
32+
* - Model
33+
- File Name
34+
* - operator
35+
- *prefix_* operator_input *_suffix*
36+
* - node
37+
- *prefix_* node_input *_suffix*
38+
* - line
39+
- | *prefix_* line_input *_suffix*
40+
| *prefix_* line_type_input *_suffix*
41+
* - switch
42+
- *prefix_* switch_input *_suffix*
43+
* - two winding transformer
44+
- | *prefix_* transformer2w_input *_suffix*
45+
| *prefix_* transformer2w_type_input *_suffix*
46+
* - three winding transformer
47+
- | *prefix_* transformer3w_input *_suffix*
48+
| *prefix_* transformer3w_type_input *_suffix*
49+
* - measurement unit
50+
- *prefix_* measurement_unit_input *_suffix*
51+
* - biomass plant
52+
- | *prefix_* bm_input *_suffix*
53+
| *prefix_* bm_type_input *_suffix*
54+
* - combined heat and power plant
55+
- | *prefix_* chp_input *_suffix*
56+
| *prefix_* chp_type_input *_suffix*
57+
* - electric vehicle
58+
- | *prefix_* ev_input *_suffix*
59+
| *prefix_* ev_type_input *_suffix*
60+
* - electric vehicle charging station
61+
- *prefix_* evcs_input *_suffix*
62+
* - fixed feed in facility
63+
- *prefix_* fixed_feed_in_input *_suffix*
64+
* - heat pump
65+
- | *prefix_* hp_input *_suffix*
66+
| *prefix_* hp_type_input *_suffix*
67+
* - load
68+
- *prefix_* load_input *_suffix*
69+
* - photovoltaic power plant
70+
- *prefix_* pv_input *_suffix*
71+
* - electrical energy storage
72+
- | *prefix_* storage_input *_suffix*
73+
| *prefix_* storage_type_input *_suffix*
74+
* - wind energy converter
75+
- | *prefix_* wec_input *_suffix*
76+
| *prefix_* wec_type_input *_suffix*
77+
* - schematic node graphic
78+
- *prefix_* node_graphic_input *_suffix*
79+
* - schematic line graphic
80+
- *prefix_* line_graphic_input *_suffix*
4881
82+
```
4983

5084
### Time Series
5185

52-
| Model | File Name |
53-
|:-----------------------|:------------------------------------------|
54-
| individual time series | *prefix_* its *_columnScheme_UUID_suffix* |
55-
| load profile input | *prefix_* rts *_profileKey_UUID_suffix* |
56-
86+
```{eval-rst}
87+
.. list-table::
88+
:widths: 50 50
89+
:header-rows: 1
90+
91+
* - Model
92+
- File Name
93+
* - individual time series
94+
- *prefix_* its *_columnScheme_UUID_suffix*
95+
* - load profile input
96+
- *prefix_* rts *_profileKey_UUID_suffix*
97+
```
5798

5899
Let's spend a few more words on the individual time series:
59100
Those files are meant to carry different types of content - one might give information about wholesale market prices,
60101
the other is a record of power values provided by a real system.
61102
To be able to understand, what's inside of the file, the *columnScheme* part of the file name gives insight of its
62103
content.
63-
The following keys are supported until now:
64104

65-
| Key | Information and supported head line |
66-
|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
67-
| c | An energy price (e.g. in €/MWh; c stands for charge). <br> Permissible head line: ``uuid,time,price`` |
68-
| p | Active power <br> Permissible head line: ``uuid,time,p`` |
69-
| pq | Active and reactive power <br> Permissible head line: ``uuid,time,p,q`` |
70-
| h | Heat power demand <br> Permissible head line: ``uuid,time,h`` |
71-
| ph | Active and heat power <br> Permissible head line: ``uuid,time,p,h`` |
72-
| pqh | Active, reactive and heat power <br> Permissible head line: ``uuid,time,p,q,h`` |
73-
| weather | Weather information <br> Permissible head line: ``uuid,time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction`` |
105+
For example, you have an IndividualTimeSeries CSV file for energy prices, then you use the key `c` from the table below
106+
for columnScheme `its_c_2fcb3e53-b94a-4b96-bea4-c469e499f1a1.csv`.
107+
The CSV file must then have the appropriate format for the key `c` :
74108

109+
```text
110+
time,price
111+
2020-01-01T00:00:00Z,100.0
112+
```
75113

76-
As the ``uuid`` and ``time`` field are mandatory, they are not mentioned explicitly, here.
114+
The CSV file requires a unique identification number.
115+
The UUID (Universally Unique Identifier) can be created [here](https://www.uuidgenerator.net/).
116+
You can also use the Method `java.util.UUID#randomUUID` to create a UUID.
117+
This is the UUID from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`.
77118

78-
### Results
119+
The following keys are supported until now:
120+
```{eval-rst}
121+
.. list-table::
122+
:widths: auto
123+
:header-rows: 1
124+
125+
* - Key
126+
- Information and supported head line
127+
* - c
128+
- | An energy price (e.g. in €/MWh; c stands for charge).
129+
| Permissible head line: ``time,price``
130+
* - p
131+
- | Active power
132+
| Permissible head line: ``time,p``
133+
* - pq
134+
- | Active and reactive power
135+
| Permissible head line: ``time,p,q``
136+
* - h
137+
- | Heat power demand
138+
| Permissible head line: ``time,h``
139+
* - ph
140+
- | Active and heat power
141+
| Permissible head line: ``time,p,h``
142+
* - pqh
143+
- | Active, reactive and heat power
144+
| Permissible head line: ``time,p,q,h``
145+
* - weather
146+
- | Weather information
147+
| Permissible head line: ``time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction``
79148
149+
```
80150

81-
| Model | File Name |
82-
|:----------------------------------|:--------------------------------------------|
83-
| node | *prefix_* node_res *_suffix* |
84-
| line | *prefix_* line_res *_suffix* |
85-
| switch | *prefix_* switch_res *_suffix* |
86-
| two winding transformer | *prefix_* transformer2w_res *_suffix* |
87-
| three winding transformer | *prefix_* transformer3w_res *_suffix* |
88-
| biomass plant | *prefix_* bm_res *_suffix* |
89-
| combined heat and power plant | *prefix_* chp_res *_suffix* |
90-
| electric vehicle | *prefix_* ev_res *_suffix* |
91-
| electric vehicle charging station | *prefix_* evcs_res\*_suffix* |
92-
| fixed feed in | *prefix_* fixed_feed_in_res *_suffix* |
93-
| heat pump | *prefix_* hp_res *_suffix* |
94-
| load | *prefix_* load_res *_suffix* |
95-
| photovoltaic power plant | *prefix_* pv_res *_suffix* |
96-
| storage | *prefix_* storage_res *_suffix* |
97-
| wind energy converter | *prefix_* wec_res *_suffix* |
98-
| thermal house model | *prefix_* thermal_house_res *_suffix* |
99-
| cylindrical thermal storage | *prefix_* cylindrical_storage_res *_suffix* |
151+
### Results
100152

153+
```{eval-rst}
154+
.. list-table::
155+
:widths: auto
156+
:header-rows: 1
157+
158+
* - Model
159+
- File Name
160+
* - node
161+
- *prefix_* node_res *_suffix*
162+
* - line
163+
- *prefix_* line_res *_suffix*
164+
* - switch
165+
- *prefix_* switch_res *_suffix*
166+
* - two winding transformer
167+
- *prefix_* transformer2w_res *_suffix*
168+
* - three winding transformer
169+
- *prefix_* transformer3w_res *_suffix*
170+
* - biomass plant
171+
- *prefix_* bm_res *_suffix*
172+
* - combined heat and power plant
173+
- *prefix_* chp_res *_suffix*
174+
* - electric vehicle
175+
- *prefix_* ev_res *_suffix*
176+
* - electric vehicle charging station
177+
- *prefix_* evcs_res\*_suffix*
178+
* - fixed feed in
179+
- *prefix_* fixed_feed_in_res *_suffix*
180+
* - heat pump
181+
- *prefix_* hp_res *_suffix*
182+
* - load
183+
- *prefix_* load_res *_suffix*
184+
* - photovoltaic power plant
185+
- *prefix_* pv_res *_suffix*
186+
* - storage
187+
- *prefix_* storage_res *_suffix*
188+
* - wind energy converter
189+
- *prefix_* wec_res *_suffix*
190+
* - thermal house model
191+
- *prefix_* thermal_house_res *_suffix*
192+
* - cylindrical thermal storage
193+
- *prefix_* cylindrical_storage_res *_suffix*
194+
195+
```
101196

102197
## Default directory hierarchy
103198

0 commit comments

Comments
 (0)