From 095f7271d7ae687fed3147aab387a8eefaf99c7e Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Mon, 29 Jan 2024 10:13:57 +0100 Subject: [PATCH 01/10] -Gridtables to Listtables --- docs/readthedocs/io/csvfiles.md | 194 +++++++++++++++++++++++--------- 1 file changed, 138 insertions(+), 56 deletions(-) diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index e022918ad..e32319642 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -24,36 +24,77 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers ### Input -| Model | File Name | -|:----------------------------------|:------------------------------------------------------------------------------------------| -| operator | *prefix_* operator_input *_suffix* | -| node | *prefix_* node_input *_suffix* | -| line | *prefix_* line_input *_suffix*
*prefix_* line_type_input *_suffix* | -| switch | *prefix_* switch_input *_suffix* | -| two winding transformer | *prefix_* transformer2w_input *_suffix*
*prefix_* transformer2w_type_input *_suffix* | -| three winding transformer | *prefix_* transformer3w_input *_suffix*
*prefix_* transformer3w_type_input *_suffix* | -| measurement unit | *prefix_* measurement_unit_input *_suffix* | -| biomass plant | *prefix_* bm_input *_suffix*
*prefix_* bm_type_input *_suffix* | -| combined heat and power plant | *prefix_* chp_input *_suffix*
*prefix_* chp_type_input *_suffix* | -| electric vehicle | *prefix_* ev_input *_suffix*
*prefix_* ev_type_input *_suffix* | -| electric vehicle charging station | *prefix_* evcs_input *_suffix* | -| fixed feed in facility | *prefix_* fixed_feed_in_input *_suffix* | -| heat pump | *prefix_* hp_input *_suffix*
*prefix_* hp_type_input *_suffix* | -| load | *prefix_* load_input *_suffix* | -| photovoltaic power plant | *prefix_* pc_input *_suffix* | -| electrical energy storage | *prefix_* storage_input *_suffix*
*prefix_* storage_type_input *_suffix* | -| wind energy converter | *prefix_* wec_input *_suffix*
*prefix_* wec_type_input *_suffix* | -| schematic node graphic | *prefix_* node_graphic_input *_suffix* | -| schematic line graphic | *prefix_* line_graphic_input *_suffix* | +```{eval-rst} +.. list-table:: + :widths: auto + :header-rows: 0 + + * - Model + - File Name + * - operator + - *prefix_* operator_input *_suffix* + * - node + - *prefix_* node_input *_suffix* + * - line + - | *prefix_* line_input *_suffix* + | *prefix_* line_type_input *_suffix* + * - switch + - *prefix_* switch_input *_suffix* + * - two winding transformer + - | *prefix_* transformer2w_input *_suffix* + | *prefix_* transformer2w_type_input *_suffix* + * - three winding transformer + - | *prefix_* transformer3w_input *_suffix* + | *prefix_* transformer3w_type_input *_suffix* + * - measurement unit + - *prefix_* measurement_unit_input *_suffix* + * - biomass plant + - | *prefix_* bm_input *_suffix* + | *prefix_* bm_type_input *_suffix* + * - combined heat and power plant + - | *prefix_* chp_input *_suffix* + | *prefix_* chp_type_input *_suffix* + * - electric vehicle + - | *prefix_* ev_input *_suffix* + | *prefix_* ev_type_input *_suffix* + * - electric vehicle charging station + - *prefix_* evcs_input *_suffix* + * - fixed feed in facility + - *prefix_* fixed_feed_in_input *_suffix* + * - heat pump + - | *prefix_* hp_input *_suffix* + | *prefix_* hp_type_input *_suffix* + * - load + - *prefix_* load_input *_suffix* + * - photovoltaic power plant + - *prefix_* pc_input *_suffix* + * - electrical energy storage + - | *prefix_* storage_input *_suffix* + | *prefix_* storage_type_input *_suffix* + * - wind energy converter + - | *prefix_* wec_input *_suffix* + | *prefix_* wec_type_input *_suffix* + * - schematic node graphic + - *prefix_* node_graphic_input *_suffix* + * - schematic line graphic + - *prefix_* line_graphic_input *_suffix* +``` ### Time Series -| Model | File Name | -|:-----------------------|:------------------------------------------| -| individual time series | *prefix_* its *_columnScheme_UUID_suffix* | -| load profile input | *prefix_* rts *_profileKey_UUID_suffix* | - +```{eval-rst} +.. list-table:: + :widths: 50 50 + :header-rows: 0 + + * - Model + - File Name + * - individual time series + - *prefix_* its *_columnScheme_UUID_suffix* + * - load profile input + - *prefix_* rts *_profileKey_UUID_suffix* +``` Let's spend a few more words on the individual time series: Those files are meant to carry different types of content - one might give information about wholesale market prices, @@ -61,43 +102,84 @@ the other is a record of power values provided by a real system. To be able to understand, what's inside of the file, the *columnScheme* part of the file name gives insight of it's content. The following keys are supported until now: +```{eval-rst} +.. list-table:: + :widths: auto + :header-rows: 0 + + * - Key + - Information and supported head line + * - c + - | An energy price (e.g. in €/MWh; c stands for charge). + | Permissible head line: ``uuid,time,price`` + * - p + - | Active power + | Permissible head line: ``uuid,time,p`` + * - pq + - | Active and reactive power + | Permissible head line: ``uuid,time,p,q`` + * - h + - | Heat power demand + | Permissible head line: ``uuid,time,h`` + * - ph + - | Active and heat power + | Permissible head line: ``uuid,time,p,h`` + * - pqh + - | Active, reactive and heat power + | Permissible head line: ``uuid,time,p,q,h`` + * - weather + - | Weather information + | Permissible head line: ``uuid,time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction`` -| Key | Information and supported head line | -|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------| -| c | An energy price (e.g. in €/MWh; c stands for charge).
Permissible head line: ``uuid,time,price`` | -| p | Active power
Permissible head line: ``uuid,time,p`` | -| pq | Active and reactive power
Permissible head line: ``uuid,time,p,q`` | -| h | Heat power demand
Permissible head line: ``uuid,time,h`` | -| ph | Active and heat power
Permissible head line: ``uuid,time,p,h`` | -| pqh | Active, reactive and heat power
Permissible head line: ``uuid,time,p,q,h`` | -| weather | Weather information
Permissible head line: ``uuid,time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction`` | - +``` As the ``uuid`` and ``time`` field are mandatory, they are not mentioned explicitly, here. ### Results +```{eval-rst} +.. list-table:: + :widths: auto + :header-rows: 0 + + * - Model + - File Name + * - node + - *prefix_* node_res *_suffix* + * - line + - *prefix_* line_res *_suffix* + * - switch + - *prefix_* switch_res *_suffix* + * - two winding transformer + - *prefix_* transformer2w_res *_suffix* + * - three winding transformer + - *prefix_* transformer3w_res *_suffix* + * - biomass plant + - *prefix_* bm_res *_suffix* + * - combined heat and power plant + - *prefix_* chp_res *_suffix* + * - electric vehicle + - *prefix_* ev_res *_suffix* + * - electric vehicle charging station + - *prefix_* evcs_res\*_suffix* + * - fixed feed in + - *prefix_* fixed_feed_in_res *_suffix* + * - heat pump + - *prefix_* hp_res *_suffix* + * - load + - *prefix_* load_res *_suffix* + * - photovoltaic power plant + - *prefix_* pv_res *_suffix* + * - storage + - *prefix_* storage_res *_suffix* + * - wind energy converter + - *prefix_* wec_res *_suffix* + * - thermal house model + - *prefix_* thermal_house_res *_suffix* + * - cylindrical thermal storage + - *prefix_* cylindrical_storage_res *_suffix* -| Model | File Name | -|:----------------------------------|:--------------------------------------------| -| node | *prefix_* node_res *_suffix* | -| line | *prefix_* line_res *_suffix* | -| switch | *prefix_* switch_res *_suffix* | -| two winding transformer | *prefix_* transformer2w_res *_suffix* | -| three winding transformer | *prefix_* transformer3w_res *_suffix* | -| biomass plant | *prefix_* bm_res *_suffix* | -| combined heat and power plant | *prefix_* chp_res *_suffix* | -| electric vehicle | *prefix_* ev_res *_suffix* | -| electric vehicle charging station | *prefix_* evcs_res\*_suffix* | -| fixed feed in | *prefix_* fixed_feed_in_res *_suffix* | -| heat pump | *prefix_* hp_res *_suffix* | -| load | *prefix_* load_res *_suffix* | -| photovoltaic power plant | *prefix_* pv_res *_suffix* | -| storage | *prefix_* storage_res *_suffix* | -| wind energy converter | *prefix_* wec_res *_suffix* | -| thermal house model | *prefix_* thermal_house_res *_suffix* | -| cylindrical thermal storage | *prefix_* cylindrical_storage_res *_suffix* | - +``` ## Default directory hierarchy From 8602a106bd73905cda6d60a198ca7db3a00f6a79 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Mon, 29 Jan 2024 10:24:30 +0100 Subject: [PATCH 02/10] -Changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a3861dd85..dfdd36d9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Formatting Spotless Groovy import order [#960](https://github.com/ie3-institute/PowerSystemDataModel/issues/960) - Implementing missing typical methods in `Try` [#970](https://github.com/ie3-institute/PowerSystemDataModel/issues/970) +- Enhance documentation for CSV timeseries [#825](https://github.com/ie3-institute/PowerSystemDataModel/issues/825) ### Fixed - Fixed Couchbase integration tests that randomly failed [#755](https://github.com/ie3-institute/PowerSystemDataModel/issues/755) From 585eed5a081ce0a9146fd029ff88ed2bacbbb49a Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Mon, 29 Jan 2024 21:43:56 +0100 Subject: [PATCH 03/10] -Enhance columneScheme Documentation --- docs/readthedocs/io/csvfiles.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index e32319642..f34566e14 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -101,6 +101,13 @@ Those files are meant to carry different types of content - one might give infor the other is a record of power values provided by a real system. To be able to understand, what's inside of the file, the *columnScheme* part of the file name gives insight of it's content. + +For example, you have an IndividualTimeSeries CSV file for energy prices, then you use the key `c` from the table below +for columnScheme `its_c_2fcb3e53-b94a-4b96-bea4-c469e499f1a1.csv`. +The CSV file must then have the appropriate format for the key `c` : + +`"uuid";"time";"price"`
`45bd936f-524a-4d59-8978-31ccf37fa230;2020-01-01T00:00:00Z;100.0` + The following keys are supported until now: ```{eval-rst} .. list-table:: @@ -133,8 +140,6 @@ The following keys are supported until now: ``` -As the ``uuid`` and ``time`` field are mandatory, they are not mentioned explicitly, here. - ### Results ```{eval-rst} From 710f59540093b13d6da64d2226b9d9d8a37df45a Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Tue, 30 Jan 2024 07:40:53 +0100 Subject: [PATCH 04/10] -ColumnScheme example -uuid generator --- docs/readthedocs/io/csvfiles.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index f34566e14..eff9d24a7 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -108,6 +108,10 @@ The CSV file must then have the appropriate format for the key `c` : `"uuid";"time";"price"`
`45bd936f-524a-4d59-8978-31ccf37fa230;2020-01-01T00:00:00Z;100.0` +The CSV file requires a unique identification number. +The UUID (Universally Unique Identifier) can be created [here](https://www.uuidgenerator.net/). +This is the uuid from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`. + The following keys are supported until now: ```{eval-rst} .. list-table:: From f7574a28177989008186c01bff8e0c775a968964 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier Date: Thu, 29 Feb 2024 18:02:10 +0100 Subject: [PATCH 05/10] fixed uuid part --- docs/readthedocs/io/csvfiles.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index eff9d24a7..e1f17176e 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -106,10 +106,19 @@ For example, you have an IndividualTimeSeries CSV file for energy prices, then y for columnScheme `its_c_2fcb3e53-b94a-4b96-bea4-c469e499f1a1.csv`. The CSV file must then have the appropriate format for the key `c` : -`"uuid";"time";"price"`
`45bd936f-524a-4d59-8978-31ccf37fa230;2020-01-01T00:00:00Z;100.0` +```{eval-rst} +.. list-table:: + :widths: auto + :header-rows: 0 + + * - ``time,price`` + * - 2020-01-01T00:00:00Z;100.0 + +``` The CSV file requires a unique identification number. The UUID (Universally Unique Identifier) can be created [here](https://www.uuidgenerator.net/). +You can also use the Method `java.util.UUID#randomUUID` to create a UUID. This is the uuid from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`. The following keys are supported until now: @@ -122,25 +131,25 @@ The following keys are supported until now: - Information and supported head line * - c - | An energy price (e.g. in €/MWh; c stands for charge). - | Permissible head line: ``uuid,time,price`` + | Permissible head line: ``time,price`` * - p - | Active power - | Permissible head line: ``uuid,time,p`` + | Permissible head line: ``time,p`` * - pq - | Active and reactive power - | Permissible head line: ``uuid,time,p,q`` + | Permissible head line: ``time,p,q`` * - h - | Heat power demand - | Permissible head line: ``uuid,time,h`` + | Permissible head line: ``time,h`` * - ph - | Active and heat power - | Permissible head line: ``uuid,time,p,h`` + | Permissible head line: ``time,p,h`` * - pqh - | Active, reactive and heat power - | Permissible head line: ``uuid,time,p,q,h`` + | Permissible head line: ``time,p,q,h`` * - weather - | Weather information - | Permissible head line: ``uuid,time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction`` + | Permissible head line: ``time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction`` ``` From ec6c4bf4e2fc530fedf6f0eec62ae616b74c210e Mon Sep 17 00:00:00 2001 From: pierrepetersmeier Date: Thu, 29 Feb 2024 18:04:46 +0100 Subject: [PATCH 06/10] CHANGELOG.md conflict --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index dfdd36d9c..b09556fe3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Formatting Spotless Groovy import order [#960](https://github.com/ie3-institute/PowerSystemDataModel/issues/960) - Implementing missing typical methods in `Try` [#970](https://github.com/ie3-institute/PowerSystemDataModel/issues/970) +- Added log warning when using `SwitchInputs` with `parallelDevices` parameter [#840](https://github.com/ie3-institute/PowerSystemDataModel/issues/840) +- Validation for `EvcsInput` [#1000](https://github.com/ie3-institute/PowerSystemDataModel/issues/1000) +- Scaling method in system participant copy builders [#1011](https://github.com/ie3-institute/PowerSystemDataModel/issues/1011) +- Added separate field for maximum power limit for DC to evtype [#876](https://github.com/ie3-institute/PowerSystemDataModel/issues/876) +- Added test for invalid input data in `CsvRawGridSource` [#1021](https://github.com/ie3-institute/PowerSystemDataModel/issues/1021) +- Added `CsvThermalGridSource` [#1009](https://github.com/ie3-institute/PowerSystemDataModel/issues/1009) - Enhance documentation for CSV timeseries [#825](https://github.com/ie3-institute/PowerSystemDataModel/issues/825) ### Fixed From d5bbbcb399667cff9803686d1bed07aa2acd954a Mon Sep 17 00:00:00 2001 From: pierrepetersmeier Date: Thu, 29 Feb 2024 18:14:14 +0100 Subject: [PATCH 07/10] uuid to UUID --- docs/readthedocs/io/csvfiles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index 61a9ee700..3dc785575 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -119,7 +119,7 @@ The CSV file must then have the appropriate format for the key `c` : The CSV file requires a unique identification number. The UUID (Universally Unique Identifier) can be created [here](https://www.uuidgenerator.net/). You can also use the Method `java.util.UUID#randomUUID` to create a UUID. -This is the uuid from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`. +This is the UUID from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`. The following keys are supported until now: ```{eval-rst} From 97620df5795d4691a81ee95fe421f53b392f8838 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier Date: Fri, 1 Mar 2024 10:47:51 +0100 Subject: [PATCH 08/10] Notes fixed --- CHANGELOG.md | 31 +++++++++++++++++++++---------- docs/readthedocs/io/csvfiles.md | 21 ++++++++------------- 2 files changed, 29 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b09556fe3..d56e74448 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,17 +21,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fixed Couchbase integration tests that randomly failed [#755](https://github.com/ie3-institute/PowerSystemDataModel/issues/755) - Fixed hyperlink in line documentation [#965](https://github.com/ie3-institute/PowerSystemDataModel/issues/965) - Fixed some tests no failing when they should [#958](https://github.com/ie3-institute/PowerSystemDataModel/issues/958) +- Fixed thermal-house-documentation [#873](https://github.com/ie3-institute/PowerSystemDataModel/issues/873) +- Fixed ElectricVehicle Documentation [#875](https://github.com/ie3-institute/PowerSystemDataModel/issues/875) +- Fixed Equal behavior of `ConnectorResult` [#1001](https://github.com/ie3-institute/PowerSystemDataModel/issues/1001) +- Fixed test for invalid input data in `CsvGraphicSource` [#1022](https://github.com/ie3-institute/PowerSystemDataModel/issues/1022) ### Changed - Changing from comparing strings to comparing uuids in `EntitySource.findFirstEntityByUuid` [#829](https://github.com/ie3-institute/PowerSystemDataModel/issues/829) - Adding JavaDoc to `EntitySource.safeMapGet` [#828](https://github.com/ie3-institute/PowerSystemDataModel/issues/828) - Abstracting some methods in `ValidationUtils` [#852](https://github.com/ie3-institute/PowerSystemDataModel/issues/852) -- `EmInput` should not be connected to the grid [#955](https://github.com/ie3-institute/PowerSystemDataModel/issues/955) -- Enhancing the error message for coordinate sources with invalid column names [#670](https://github.com/ie3-institute/PowerSystemDataModel/issues/670) +- Changes to Energy Management inputs: + - `EmInput` should not be connected to the grid [#955](https://github.com/ie3-institute/PowerSystemDataModel/issues/955) + - System participants now reference the em entity [#957](https://github.com/ie3-institute/PowerSystemDataModel/issues/957) +- Enhancing the error message for coordinate sources with invalid column names [#670](https://github.com/ie3-institute/PowerSystemDataModel/issues/670) - Allowing for additional unused columns in sources [#839](https://github.com/ie3-institute/PowerSystemDataModel/issues/839) - Improving column name validation to only run once per source [#849](https://github.com/ie3-institute/PowerSystemDataModel/issues/849) - Refactored and abstracted `EntitySource`s and `EntityData` creation [#969](https://github.com/ie3-institute/PowerSystemDataModel/issues/969) - Updated contributing.md [#737](https://github.com/ie3-institute/PowerSystemDataModel/issues/737) +- Don't throw exceptions for not yet implemented validations [#879](https://github.com/ie3-institute/PowerSystemDataModel/issues/879) +- `CsvDataSource` throws exceptions on error [#954](https://github.com/ie3-institute/PowerSystemDataModel/issues/954) +- Removing `uuid` as required column from input and result time series [#826](https://github.com/ie3-institute/PowerSystemDataModel/issues/826) +- Removing the support for the old csv format that was marked `deprecated` back in version `1.1.0` [#795](https://github.com/ie3-institute/PowerSystemDataModel/issues/795) +- BREAKING: Updating PowerSystemUtils dependency to 2.2 [#1006](https://github.com/ie3-institute/PowerSystemDataModel/issues/1006) ## [4.1.0] - 2023-11-02 @@ -54,7 +65,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Fixed wrong rated power unit hint [#804](https://github.com/ie3-institute/PowerSystemDataModel/issues/804) -- Fixed wrong hash code generation of ConnectorResult [#817](https://github.com/ie3-institute/PowerSystemDataModel/issues/817) +- Fixed wrong hash code generation of ConnectorResult [#817](https://github.com/ie3-institute/PowerSystemDataModel/issues/817) - Fixed wrong path for timeSeriesMapping [#886](https://github.com/ie3-institute/PowerSystemDataModel/issues/886) ### Changed @@ -117,7 +128,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - BREAKING: PvInput Model parameter name height changed to elevationAngle [#393](https://github.com/ie3-institute/PowerSystemDataModel/issues/393) :warning: - BREAKING: Transformer's no load susceptance needs to be zero or negative to pass model validation [#378](https://github.com/ie3-institute/PowerSystemDataModel/issues/378) - All input data sets for version < 3.0.0 need to be altered! -- Deprecating (as part of [#513](https://github.com/ie3-institute/PowerSystemDataModel/issues/513)): +- Deprecating (as part of [#513](https://github.com/ie3-institute/PowerSystemDataModel/issues/513)): - `edu.ie3.datamodel.io.csv.timeseries.ColumnScheme` - `edu.ie3.datamodel.io.csv.FileNameMetaInformation` - `edu.ie3.datamodel.io.csv.timeseries.IndividualTimeSeriesMetaInformation` @@ -207,10 +218,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed - BREAKING: Removed deprecated code parts - - Intermingled builder pattern and constructors in `SubGridGate` - - `TarballUtils` that have been transferred to `FileIOUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils) - - `FileNamingStrategy` that has been transferred to `EntityPersistenceNamingStrategy` - - `EvCharacteristicInput` and `TimeSeriesContainer` that shouldn't be used anymore + - Intermingled builder pattern and constructors in `SubGridGate` + - `TarballUtils` that have been transferred to `FileIOUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils) + - `FileNamingStrategy` that has been transferred to `EntityPersistenceNamingStrategy` + - `EvCharacteristicInput` and `TimeSeriesContainer` that shouldn't be used anymore ### Fixed - InfluxDbConnector now keeps session instead of creating a new one each call @@ -245,7 +256,7 @@ most of the commonly known power flow calculations ### Changed - Disabled concurrent writing in `CsvFileSink.persistJointGrid()` as this caused concurrency issues -- Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal +- Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal coordinates or multiple exactly equal coordinates possible - Extended functionality of `GridAndGeoUtils` - `CsvFileConnector` is now set up to process either UniqueEntities or only by file name @@ -266,4 +277,4 @@ coordinates or multiple exactly equal coordinates possible [2.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.1...2.1.0 [2.0.1]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.0...2.0.1 [2.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...2.0.0 -[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0 +[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0 \ No newline at end of file diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index 3dc785575..51b498562 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -27,7 +27,7 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers ```{eval-rst} .. list-table:: :widths: auto - :header-rows: 0 + :header-rows: 1 * - Model - File Name @@ -67,7 +67,7 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers * - load - *prefix_* load_input *_suffix* * - photovoltaic power plant - - *prefix_* pc_input *_suffix* + - *prefix_* pv_input *_suffix* * - electrical energy storage - | *prefix_* storage_input *_suffix* | *prefix_* storage_type_input *_suffix* @@ -86,7 +86,7 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers ```{eval-rst} .. list-table:: :widths: 50 50 - :header-rows: 0 + :header-rows: 1 * - Model - File Name @@ -106,14 +106,9 @@ For example, you have an IndividualTimeSeries CSV file for energy prices, then y for columnScheme `its_c_2fcb3e53-b94a-4b96-bea4-c469e499f1a1.csv`. The CSV file must then have the appropriate format for the key `c` : -```{eval-rst} -.. list-table:: - :widths: auto - :header-rows: 0 - - * - ``time,price`` - * - 2020-01-01T00:00:00Z;100.0 - +``` + time,price + 2020-01-01T00:00:00Z,100.0 ``` The CSV file requires a unique identification number. @@ -125,7 +120,7 @@ The following keys are supported until now: ```{eval-rst} .. list-table:: :widths: auto - :header-rows: 0 + :header-rows: 1 * - Key - Information and supported head line @@ -158,7 +153,7 @@ The following keys are supported until now: ```{eval-rst} .. list-table:: :widths: auto - :header-rows: 0 + :header-rows: 1 * - Model - File Name From fa0c802cba04f00ae7d01e0c2ffd0159a6cdc1d3 Mon Sep 17 00:00:00 2001 From: Sebastian Peter Date: Mon, 4 Mar 2024 11:17:08 +0100 Subject: [PATCH 09/10] Reverting whitespace changes in changelog --- CHANGELOG.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d56e74448..9788bc342 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fixed some tests no failing when they should [#958](https://github.com/ie3-institute/PowerSystemDataModel/issues/958) - Fixed thermal-house-documentation [#873](https://github.com/ie3-institute/PowerSystemDataModel/issues/873) - Fixed ElectricVehicle Documentation [#875](https://github.com/ie3-institute/PowerSystemDataModel/issues/875) -- Fixed Equal behavior of `ConnectorResult` [#1001](https://github.com/ie3-institute/PowerSystemDataModel/issues/1001) +- Fixed Equal behavior of `ConnectorResult` [#1001](https://github.com/ie3-institute/PowerSystemDataModel/issues/1001) - Fixed test for invalid input data in `CsvGraphicSource` [#1022](https://github.com/ie3-institute/PowerSystemDataModel/issues/1022) ### Changed @@ -33,7 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Changes to Energy Management inputs: - `EmInput` should not be connected to the grid [#955](https://github.com/ie3-institute/PowerSystemDataModel/issues/955) - System participants now reference the em entity [#957](https://github.com/ie3-institute/PowerSystemDataModel/issues/957) -- Enhancing the error message for coordinate sources with invalid column names [#670](https://github.com/ie3-institute/PowerSystemDataModel/issues/670) +- Enhancing the error message for coordinate sources with invalid column names [#670](https://github.com/ie3-institute/PowerSystemDataModel/issues/670) - Allowing for additional unused columns in sources [#839](https://github.com/ie3-institute/PowerSystemDataModel/issues/839) - Improving column name validation to only run once per source [#849](https://github.com/ie3-institute/PowerSystemDataModel/issues/849) - Refactored and abstracted `EntitySource`s and `EntityData` creation [#969](https://github.com/ie3-institute/PowerSystemDataModel/issues/969) @@ -65,7 +65,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Fixed wrong rated power unit hint [#804](https://github.com/ie3-institute/PowerSystemDataModel/issues/804) -- Fixed wrong hash code generation of ConnectorResult [#817](https://github.com/ie3-institute/PowerSystemDataModel/issues/817) +- Fixed wrong hash code generation of ConnectorResult [#817](https://github.com/ie3-institute/PowerSystemDataModel/issues/817) - Fixed wrong path for timeSeriesMapping [#886](https://github.com/ie3-institute/PowerSystemDataModel/issues/886) ### Changed @@ -128,7 +128,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - BREAKING: PvInput Model parameter name height changed to elevationAngle [#393](https://github.com/ie3-institute/PowerSystemDataModel/issues/393) :warning: - BREAKING: Transformer's no load susceptance needs to be zero or negative to pass model validation [#378](https://github.com/ie3-institute/PowerSystemDataModel/issues/378) - All input data sets for version < 3.0.0 need to be altered! -- Deprecating (as part of [#513](https://github.com/ie3-institute/PowerSystemDataModel/issues/513)): +- Deprecating (as part of [#513](https://github.com/ie3-institute/PowerSystemDataModel/issues/513)): - `edu.ie3.datamodel.io.csv.timeseries.ColumnScheme` - `edu.ie3.datamodel.io.csv.FileNameMetaInformation` - `edu.ie3.datamodel.io.csv.timeseries.IndividualTimeSeriesMetaInformation` @@ -218,10 +218,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed - BREAKING: Removed deprecated code parts - - Intermingled builder pattern and constructors in `SubGridGate` - - `TarballUtils` that have been transferred to `FileIOUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils) - - `FileNamingStrategy` that has been transferred to `EntityPersistenceNamingStrategy` - - `EvCharacteristicInput` and `TimeSeriesContainer` that shouldn't be used anymore + - Intermingled builder pattern and constructors in `SubGridGate` + - `TarballUtils` that have been transferred to `FileIOUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils) + - `FileNamingStrategy` that has been transferred to `EntityPersistenceNamingStrategy` + - `EvCharacteristicInput` and `TimeSeriesContainer` that shouldn't be used anymore ### Fixed - InfluxDbConnector now keeps session instead of creating a new one each call @@ -256,7 +256,7 @@ most of the commonly known power flow calculations ### Changed - Disabled concurrent writing in `CsvFileSink.persistJointGrid()` as this caused concurrency issues -- Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal +- Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal coordinates or multiple exactly equal coordinates possible - Extended functionality of `GridAndGeoUtils` - `CsvFileConnector` is now set up to process either UniqueEntities or only by file name @@ -277,4 +277,4 @@ coordinates or multiple exactly equal coordinates possible [2.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.1...2.1.0 [2.0.1]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.0...2.0.1 [2.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...2.0.0 -[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0 \ No newline at end of file +[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0 From 0881c7832ebcfe2031cbc11788b3e780343f3ee9 Mon Sep 17 00:00:00 2001 From: Sebastian Peter Date: Mon, 4 Mar 2024 11:49:43 +0100 Subject: [PATCH 10/10] Removing syntax highlighting --- docs/readthedocs/io/csvfiles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/io/csvfiles.md b/docs/readthedocs/io/csvfiles.md index 51b498562..398b36cc3 100644 --- a/docs/readthedocs/io/csvfiles.md +++ b/docs/readthedocs/io/csvfiles.md @@ -106,7 +106,7 @@ For example, you have an IndividualTimeSeries CSV file for energy prices, then y for columnScheme `its_c_2fcb3e53-b94a-4b96-bea4-c469e499f1a1.csv`. The CSV file must then have the appropriate format for the key `c` : -``` +```text time,price 2020-01-01T00:00:00Z,100.0 ```