Skip to content

Commit 095f727

Browse files
pierrepetersmeierpierrepetersmeier
committed
-Gridtables to Listtables
1 parent ddbc3f5 commit 095f727

File tree

1 file changed

+138
-56
lines changed

1 file changed

+138
-56
lines changed

‎docs/readthedocs/io/csvfiles.md‎

Lines changed: 138 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -24,80 +24,162 @@ 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: 0
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_* pc_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: 0
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 it's
62103
content.
63104
The following keys are supported until now:
105+
```{eval-rst}
106+
.. list-table::
107+
:widths: auto
108+
:header-rows: 0
109+
110+
* - Key
111+
- Information and supported head line
112+
* - c
113+
- | An energy price (e.g. in €/MWh; c stands for charge).
114+
| Permissible head line: ``uuid,time,price``
115+
* - p
116+
- | Active power
117+
| Permissible head line: ``uuid,time,p``
118+
* - pq
119+
- | Active and reactive power
120+
| Permissible head line: ``uuid,time,p,q``
121+
* - h
122+
- | Heat power demand
123+
| Permissible head line: ``uuid,time,h``
124+
* - ph
125+
- | Active and heat power
126+
| Permissible head line: ``uuid,time,p,h``
127+
* - pqh
128+
- | Active, reactive and heat power
129+
| Permissible head line: ``uuid,time,p,q,h``
130+
* - weather
131+
- | Weather information
132+
| Permissible head line: ``uuid,time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction``
64133
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`` |
74-
134+
```
75135

76136
As the ``uuid`` and ``time`` field are mandatory, they are not mentioned explicitly, here.
77137

78138
### Results
79139

140+
```{eval-rst}
141+
.. list-table::
142+
:widths: auto
143+
:header-rows: 0
144+
145+
* - Model
146+
- File Name
147+
* - node
148+
- *prefix_* node_res *_suffix*
149+
* - line
150+
- *prefix_* line_res *_suffix*
151+
* - switch
152+
- *prefix_* switch_res *_suffix*
153+
* - two winding transformer
154+
- *prefix_* transformer2w_res *_suffix*
155+
* - three winding transformer
156+
- *prefix_* transformer3w_res *_suffix*
157+
* - biomass plant
158+
- *prefix_* bm_res *_suffix*
159+
* - combined heat and power plant
160+
- *prefix_* chp_res *_suffix*
161+
* - electric vehicle
162+
- *prefix_* ev_res *_suffix*
163+
* - electric vehicle charging station
164+
- *prefix_* evcs_res\*_suffix*
165+
* - fixed feed in
166+
- *prefix_* fixed_feed_in_res *_suffix*
167+
* - heat pump
168+
- *prefix_* hp_res *_suffix*
169+
* - load
170+
- *prefix_* load_res *_suffix*
171+
* - photovoltaic power plant
172+
- *prefix_* pv_res *_suffix*
173+
* - storage
174+
- *prefix_* storage_res *_suffix*
175+
* - wind energy converter
176+
- *prefix_* wec_res *_suffix*
177+
* - thermal house model
178+
- *prefix_* thermal_house_res *_suffix*
179+
* - cylindrical thermal storage
180+
- *prefix_* cylindrical_storage_res *_suffix*
80181
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* |
100-
182+
```
101183

102184
## Default directory hierarchy
103185

0 commit comments

Comments
 (0)