Release v2.0.0

.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+- package-ecosystem: gradle
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  target-branch: dev
+  reviewers:
+  - ckittl
+  - johanneshiry
+  - t-ober
+  - sensarmad
+  ignore:
+  - dependency-name: org.jgrapht:jgrapht-core
+    versions:
+    - ">= 1.5.a, < 1.6"

.gitignore

@@ -240,4 +240,6 @@ docs/readthedocs/_build
 **/*.aux
 **/*.pdf
 **/*.synctex.gz
-**/*.synctex(busy)
+**/*.synctex(busy)
+
+docs/javadoc

AUTHORS

@@ -14,6 +14,9 @@ Main Contributers:
     - Dennis Strehle - https://github.com/denstre
     - Sebastian Peter - https://github.com/sebastian-peter
     - Christian Mahr - https://github.com/cmahr93
+    - Vasilios Zachopoulos - https://github.com/baszach
+    - Shubham Bajpai - https://github.com/ahamshubham
+    - Thomas Oberließen - https://github.com/t-ober
 
 Coordination:
     - Chris Kittl

CHANGELOG.md

@@ -6,38 +6,85 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+-   definition for a default input file directory structure
+-   tarball utils to extract and compress files
+-   added electric vehicle charging station implementation ``EvcsInput``
+-   reading time series from csv files (including a container object to hold the different types of time series)
+-   reading mapping from participant uuid to time series uuid including a mapping object for easy access to time series
+-   Couchbase, SQL and CSV connectors and sources for weather data
+-   added validation utils that can be used to check whether objects have valid values (no usage implemented yet)
+-   added `SystemParticipantWithHeatResult` with thermal power variable to be used by heat plant result models
+
+### Changed
+-   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)
+-   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)
+-   moved api docs to own branch incl. automated api-docs deployment
+-   added methods for nearest and all coordinates to IdCoordinateSource
+-   utilize factory in IdCoordinateSource to maintain highest possible flexibility
+-   added coordinate distance sort method to GridAndGeoUtils
+-   BREAKING: Harmonized field naming for time information
+-   BREAKING: Properly applying snake case to result file names
+-   deprecated `TarballUtils`
+-   updated Indriya to version 2.1.2 to include fixes for serialization
+-   Reworking the time series source (one source per time series, distinct mapping source, factory pattern)
+-   BREAKING: Moved methods `buildSafe{Coord,Point,LineString,LineStringBetweenCoords,LineStringBetweenPoints}`, `totalLengthOfLineString` from `GridAndGeoUtils` to `GeoUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
+-   BREAKING: Moved `CoordinateDistance` to [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
+-   Factory methods for `SubGridGate`
+-   BREAKING: Inheritance hierarchy of exceptions all around entity validation
+
+### 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
+
+### Fixed
+-   InfluxDbConnector now keeps session instead of creating a new one each call
+(resolves [#247](https://github.com/ie3-institute/PowerSystemDataModel/issues/247)
+and [#248](https://github.com/ie3-institute/PowerSystemDataModel/issues/248))
+-   BREAKING: fix invalid application of solar irradiance / irradiation ([#266](https://github.com/ie3-institute/PowerSystemDataModel/issues/266))
+-   BREAKING: deleted `IrradiationValue` as it is invalid and no longer required
+-   added copy builder implementations for thermal input models `CylindricalStorageInput`, `ThermalBusInput` and `ThermalHouseInput`
+-   the sample code for reading and writing model data from respectively to csv files documented in the Sphinx documentation is fixed
+
 ## [1.1.0] - 2020-09-15
 
 ### Added
--  Headline in csv files is now mandatory. CsvDataSource checks for existing field `uuid` in first row of .csv file
--  Minor logging improvements
--  New constructor in ``Transformer3WInput`` that allows the internal node to be marked as slack
--  Method in ``ContainerUtils`` to modify a provided ``SubGridContainer`` with slack nodes and make it usable for
+-   Headline in csv files is now mandatory. CsvDataSource checks for existing field `uuid` in first row of .csv file
+-   Minor logging improvements
+-   New constructor in ``Transformer3WInput`` that allows the internal node to be marked as slack
+-   Method in ``ContainerUtils`` to modify a provided ``SubGridContainer`` with slack nodes and make it usable for
 most of the commonly known power flow calculations
--  gradle task to create JavaDoc HTML files in the folder 'docs/javadoc'
--  added missing ``HpResult`` model
--  Implementation of ``DataConnector``, ``WeatherSource`` and ``DataSink`` for InfluxDB
--  Introduction of a ``IdCoordinateSource`` and implementation of  corresponding csv source for ID to coordinate mapping
--  Factory for ``TimeBasedValues<WeatherValue>``
--  Documentation with Sphinx / ReadTheDocs: [https://powersystemdatamodel.readthedocs.io/en/latest/](https://powersystemdatamodel.readthedocs.io/en/latest/)
--  Introduction of``SwitchResultFactory`` to build adapted ``SwitchResult`` entities
--  Copy method for all `RawGridElements` and `SystemParticipants` input entities which allow an easy to use entity copy with altered field values
--  ``distanceBetweenNodes(NodeInput nodeA, NodeInput nodeB)`` in ``GridAndGeoUtils``
--  Additional constructors based on lists of entities in ``RawGridElements``, ``SystemParticipants`` and ``GraphicElements``
--  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
--  Added ``ContainerNodeUpdateUtil`` to support updating nested nodes in ``GridContainer`` instances
--  Gradle task `gradle finalizePR` to format and test the code as well as generate JavaDoc
+-   gradle task to create JavaDoc HTML files in the folder 'docs/javadoc'
+-   added missing ``HpResult`` model
+-   Implementation of ``DataConnector``, ``WeatherSource`` and ``DataSink`` for InfluxDB
+-   Introduction of a ``IdCoordinateSource`` and implementation of  corresponding csv source for ID to coordinate mapping
+-   Factory for ``TimeBasedValues<WeatherValue>``
+-   Documentation with Sphinx / ReadTheDocs: [https://powersystemdatamodel.readthedocs.io/en/latest/](https://powersystemdatamodel.readthedocs.io/en/latest/)
+-   Introduction of``SwitchResultFactory`` to build adapted ``SwitchResult`` entities
+-   Copy method for all `RawGridElements` and `SystemParticipants` input entities which allow an easy to use entity copy with altered field values
+-   ``distanceBetweenNodes(NodeInput nodeA, NodeInput nodeB)`` in ``GridAndGeoUtils``
+-   Additional constructors based on lists of entities in ``RawGridElements``, ``SystemParticipants`` and ``GraphicElements``
+-   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
+-   Added ``ContainerNodeUpdateUtil`` to support updating nested nodes in ``GridContainer`` instances
+-   Gradle task `gradle finalizePR` to format and test the code as well as generate JavaDoc
 
 ### 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
+-   Disabled concurrent writing in `CsvFileSink.persistJointGrid()` as this caused concurrency issues
+-   Modifications in `LineInput` and `GraphicInput` constructors to make `LineStrings` with two exactly equal
 coordinates or multiple exactly equal coordinates possible
--  Extended functionality of `GridAndGeoUtils`
+-   Extended functionality of `GridAndGeoUtils`
 - `CsvFileConnector` is now set up to process either UniqueEntities or only by file name
 - `SwitchResult` superclass changed from `ConnectorResult` to `ResultEntity`
 - ``CsvDataSource`` now parses valid RFC 4180 rows correctly (invalid, old syntax is still supported but deprecated!)
--  Consolidate test tasks. `gradle allTests` is now replaced by `gradle test`. Only unit tests can be run with `gradle unitTest`.
+-   Consolidate test tasks. `gradle allTests` is now replaced by `gradle test`. Only unit tests can be run with `gradle unitTest`.
+- Changed projects toString() methods for readability/completeness
 
 ### Fixed
--  CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
--  CsvDataSource now parsing multiple geoJson strings correctly
+-   CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
+-   CsvDataSource now parsing multiple geoJson strings correctly
+
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0

CONTRIBUTING.md

@@ -63,7 +63,6 @@ Before marking the pull request as 'ready to review', take these precautionary a
 
 * Are all tests passing? Run `gradle test`
 * Is your code properly formatted? Run `gradle spotlessApply`
-* Update the javadoc pages. Run `gradle javadoc`
 
 `gradle finalizePR` summarizes all of these steps .