Skip to content

Commit f81c449

Browse files
authored
Merge pull request #350 from ie3-institute/rel/jh/#349-v-2-0-0
Release v2.0.0
2 parents 69c8ab2 + 154cc7b commit f81c449

File tree

923 files changed

+18329
-131629
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

923 files changed

+18329
-131629
lines changed

.github/dependabot.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: gradle
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
time: "04:00"
8+
open-pull-requests-limit: 10
9+
target-branch: dev
10+
reviewers:
11+
- ckittl
12+
- johanneshiry
13+
- t-ober
14+
- sensarmad
15+
ignore:
16+
- dependency-name: org.jgrapht:jgrapht-core
17+
versions:
18+
- ">= 1.5.a, < 1.6"

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,4 +240,6 @@ docs/readthedocs/_build
240240
**/*.aux
241241
**/*.pdf
242242
**/*.synctex.gz
243-
**/*.synctex(busy)
243+
**/*.synctex(busy)
244+
245+
docs/javadoc

AUTHORS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ Main Contributers:
1414
- Dennis Strehle - https://github.com/denstre
1515
- Sebastian Peter - https://github.com/sebastian-peter
1616
- Christian Mahr - https://github.com/cmahr93
17+
- Vasilios Zachopoulos - https://github.com/baszach
18+
- Shubham Bajpai - https://github.com/ahamshubham
19+
- Thomas Oberließen - https://github.com/t-ober
1720

1821
Coordination:
1922
- Chris Kittl

CHANGELOG.md

Lines changed: 70 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,85 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased/Snapshot]
88

9+
### Added
10+
- definition for a default input file directory structure
11+
- tarball utils to extract and compress files
12+
- added electric vehicle charging station implementation ``EvcsInput``
13+
- reading time series from csv files (including a container object to hold the different types of time series)
14+
- reading mapping from participant uuid to time series uuid including a mapping object for easy access to time series
15+
- Couchbase, SQL and CSV connectors and sources for weather data
16+
- added validation utils that can be used to check whether objects have valid values (no usage implemented yet)
17+
- added `SystemParticipantWithHeatResult` with thermal power variable to be used by heat plant result models
18+
19+
### Changed
20+
- BREAKING: replaced [Unit API 1.0](https://github.com/unitsofmeasurement/uom-se) (JSR 363, tec.uom.se) with [Unit API 2.0](https://github.com/unitsofmeasurement/indriya) (JSR 385, tech.units.indriya)
21+
- added possibility to allow `null` values in time series for missing values (e.g. if some measure data points from real world data time series are missing)
22+
- moved api docs to own branch incl. automated api-docs deployment
23+
- added methods for nearest and all coordinates to IdCoordinateSource
24+
- utilize factory in IdCoordinateSource to maintain highest possible flexibility
25+
- added coordinate distance sort method to GridAndGeoUtils
26+
- BREAKING: Harmonized field naming for time information
27+
- BREAKING: Properly applying snake case to result file names
28+
- deprecated `TarballUtils`
29+
- updated Indriya to version 2.1.2 to include fixes for serialization
30+
- Reworking the time series source (one source per time series, distinct mapping source, factory pattern)
31+
- BREAKING: Moved methods `buildSafe{Coord,Point,LineString,LineStringBetweenCoords,LineStringBetweenPoints}`, `totalLengthOfLineString` from `GridAndGeoUtils` to `GeoUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
32+
- BREAKING: Moved `CoordinateDistance` to [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
33+
- Factory methods for `SubGridGate`
34+
- BREAKING: Inheritance hierarchy of exceptions all around entity validation
35+
36+
### Removed
37+
- BREAKING: Removed deprecated code parts
38+
- Intermingled builder pattern and constructors in `SubGridGate`
39+
- `TarballUtils` that have been transferred to `FileIOUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
40+
- `FileNamingStrategy` that has been transferred to `EntityPersistenceNamingStrategy`
41+
- `EvCharacteristicInput` and `TimeSeriesContainer` that shouldn't be used anymore
42+
43+
### Fixed
44+
- InfluxDbConnector now keeps session instead of creating a new one each call
45+
(resolves [#247](https://github.com/ie3-institute/PowerSystemDataModel/issues/247)
46+
and [#248](https://github.com/ie3-institute/PowerSystemDataModel/issues/248))
47+
- BREAKING: fix invalid application of solar irradiance / irradiation ([#266](https://github.com/ie3-institute/PowerSystemDataModel/issues/266))
48+
- BREAKING: deleted `IrradiationValue` as it is invalid and no longer required
49+
- added copy builder implementations for thermal input models `CylindricalStorageInput`, `ThermalBusInput` and `ThermalHouseInput`
50+
- the sample code for reading and writing model data from respectively to csv files documented in the Sphinx documentation is fixed
51+
952
## [1.1.0] - 2020-09-15
1053

1154
### Added
12-
- Headline in csv files is now mandatory. CsvDataSource checks for existing field `uuid` in first row of .csv file
13-
- Minor logging improvements
14-
- New constructor in ``Transformer3WInput`` that allows the internal node to be marked as slack
15-
- Method in ``ContainerUtils`` to modify a provided ``SubGridContainer`` with slack nodes and make it usable for
55+
- Headline in csv files is now mandatory. CsvDataSource checks for existing field `uuid` in first row of .csv file
56+
- Minor logging improvements
57+
- New constructor in ``Transformer3WInput`` that allows the internal node to be marked as slack
58+
- Method in ``ContainerUtils`` to modify a provided ``SubGridContainer`` with slack nodes and make it usable for
1659
most of the commonly known power flow calculations
17-
- gradle task to create JavaDoc HTML files in the folder 'docs/javadoc'
18-
- added missing ``HpResult`` model
19-
- Implementation of ``DataConnector``, ``WeatherSource`` and ``DataSink`` for InfluxDB
20-
- Introduction of a ``IdCoordinateSource`` and implementation of corresponding csv source for ID to coordinate mapping
21-
- Factory for ``TimeBasedValues<WeatherValue>``
22-
- Documentation with Sphinx / ReadTheDocs: [https://powersystemdatamodel.readthedocs.io/en/latest/](https://powersystemdatamodel.readthedocs.io/en/latest/)
23-
- Introduction of``SwitchResultFactory`` to build adapted ``SwitchResult`` entities
24-
- Copy method for all `RawGridElements` and `SystemParticipants` input entities which allow an easy to use entity copy with altered field values
25-
- ``distanceBetweenNodes(NodeInput nodeA, NodeInput nodeB)`` in ``GridAndGeoUtils``
26-
- Additional constructors based on lists of entities in ``RawGridElements``, ``SystemParticipants`` and ``GraphicElements``
27-
- Added ``DistanceWeightedGraph`` + corresponding utility method to generate a graph topology whose vertices are `NodeInput` entities and its edges are weighted with the distance between the vertices in meter
28-
- Added ``ContainerNodeUpdateUtil`` to support updating nested nodes in ``GridContainer`` instances
29-
- Gradle task `gradle finalizePR` to format and test the code as well as generate JavaDoc
60+
- gradle task to create JavaDoc HTML files in the folder 'docs/javadoc'
61+
- added missing ``HpResult`` model
62+
- Implementation of ``DataConnector``, ``WeatherSource`` and ``DataSink`` for InfluxDB
63+
- Introduction of a ``IdCoordinateSource`` and implementation of corresponding csv source for ID to coordinate mapping
64+
- Factory for ``TimeBasedValues<WeatherValue>``
65+
- Documentation with Sphinx / ReadTheDocs: [https://powersystemdatamodel.readthedocs.io/en/latest/](https://powersystemdatamodel.readthedocs.io/en/latest/)
66+
- Introduction of``SwitchResultFactory`` to build adapted ``SwitchResult`` entities
67+
- Copy method for all `RawGridElements` and `SystemParticipants` input entities which allow an easy to use entity copy with altered field values
68+
- ``distanceBetweenNodes(NodeInput nodeA, NodeInput nodeB)`` in ``GridAndGeoUtils``
69+
- Additional constructors based on lists of entities in ``RawGridElements``, ``SystemParticipants`` and ``GraphicElements``
70+
- Added ``DistanceWeightedGraph`` + corresponding utility method to generate a graph topology whose vertices are `NodeInput` entities and its edges are weighted with the distance between the vertices in meter
71+
- Added ``ContainerNodeUpdateUtil`` to support updating nested nodes in ``GridContainer`` instances
72+
- Gradle task `gradle finalizePR` to format and test the code as well as generate JavaDoc
3073

3174
### Changed
32-
- Disabled concurrent writing in `CsvFileSink.persistJointGrid()` as this caused concurrency issues
33-
- Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal
75+
- Disabled concurrent writing in `CsvFileSink.persistJointGrid()` as this caused concurrency issues
76+
- Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal
3477
coordinates or multiple exactly equal coordinates possible
35-
- Extended functionality of `GridAndGeoUtils`
78+
- Extended functionality of `GridAndGeoUtils`
3679
- `CsvFileConnector` is now set up to process either UniqueEntities or only by file name
3780
- `SwitchResult` superclass changed from `ConnectorResult` to `ResultEntity`
3881
- ``CsvDataSource`` now parses valid RFC 4180 rows correctly (invalid, old syntax is still supported but deprecated!)
39-
- Consolidate test tasks. `gradle allTests` is now replaced by `gradle test`. Only unit tests can be run with `gradle unitTest`.
82+
- Consolidate test tasks. `gradle allTests` is now replaced by `gradle test`. Only unit tests can be run with `gradle unitTest`.
83+
- Changed projects toString() methods for readability/completeness
4084

4185
### Fixed
42-
- CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
43-
- CsvDataSource now parsing multiple geoJson strings correctly
86+
- CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
87+
- CsvDataSource now parsing multiple geoJson strings correctly
88+
89+
[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...HEAD
90+
[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ Before marking the pull request as 'ready to review', take these precautionary a
6363

6464
* Are all tests passing? Run `gradle test`
6565
* Is your code properly formatted? Run `gradle spotlessApply`
66-
* Update the javadoc pages. Run `gradle javadoc`
6766

6867
`gradle finalizePR` summarizes all of these steps .
6968

0 commit comments

Comments
 (0)