Merge pull request #485 from ie3-institute/rel/jh/#484-release_v2.1.0

Release v2.1.0
ie3-institute · Jan 5, 2022 · 22694a0 · 22694a0
2 parents 9e058b8 + 25a6254
commit 22694a0
Show file tree

Hide file tree

Showing 123 changed files with 5,207 additions and 1,766 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,21 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+# Configure python
+python:
+  install:
+    - requirements: docs/readthedocs/requirements.txt
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/readthedocs/conf.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+## [2.1.0] - 2022-01-05
+
+### Added
+- added `EvcsLocationType` support in `EvcsInput` and `EvcsInputFactory` [#406](https://github.com/ie3-institute/PowerSystemDataModel/issues/406)
+- Opportunity to close writer in `CsvFileSink`
+
+### Fixed
+- adapted `LineInput` constructor to convert line length to `StandardUnits.LINE_LENGTH` [#412](https://github.com/ie3-institute/PowerSystemDataModel/issues/412)
+
+### Changed
+- Writers used to write time series are closed right away
+
 ## [2.0.1] - 2021-07-08
 
 ### Fixed
@@ -14,6 +26,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.0.0] - 2021-05-21
 
+### Added
+-   added `ResultEntitySource` interface
+-   added `CsvResultEntitySource` implementation to read `ResultEntity` instances from .csv files
+-   added target temperature including tolerance boundaries to `ThermalHouseInput`
+
+### Changed
+-   separated entity and file naming and introduced a new FileNamingStrategy taking an EntityNamingStrategy and a FileHierarchy as arguments
+
+### Fixed
+-   `CsvSystemParticipantSource#getSystemParticipants()` now correctly returns electric vehicle charging station input models [PR#370](https://github.com/ie3-institute/PowerSystemDataModel/pull/370)
+
+## [2.0.0] - 2021-05-21
+
 ### Added
 -   definition for a default input file directory structure
 -   tarball utils to extract and compress files
@@ -94,7 +119,8 @@ coordinates or multiple exactly equal coordinates possible
 -   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/2.0.1...HEAD
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.1.0...HEAD
+[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
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -104,6 +104,8 @@ node {
             // test the project
             stage('run tests') {
 
+                sh 'java -version'
+
                 gradle('--refresh-dependencies clean spotlessCheck pmdMain pmdTest spotbugsMain ' +
                         'spotbugsTest test jacocoTestReport jacocoTestCoverageVerification', projectName)
 
@@ -150,7 +152,7 @@ node {
                          */
                         sh(
                                 script: """set +x && cd $projectName""" +
-                                ''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk''',
+                                        ''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk''',
                                 returnStdout: true
                         )
 
@@ -706,8 +708,7 @@ def getBranchType(String branchName) {
     def main_pattern = ".*main"
     if (branchName =~ feature_pattern || branchName =~ dependabot_pattern) {
         return "feature"
-    } else
-    if (branchName =~ release_pattern) {
+    } else if (branchName =~ release_pattern) {
         return "release"
     } else if (branchName =~ main_pattern) {
         return "main"

diff --git a/build.gradle b/build.gradle
@@ -4,21 +4,20 @@ plugins {
 	id 'maven-publish'
 	id 'signing'
 	id 'pmd' // code check, working on source code
-	id 'com.diffplug.spotless' version '5.12.5'//code format
-	id 'com.github.spotbugs' version '4.7.1' // code check, working on byte code
-	id 'com.github.onslip.gradle-one-jar' version '1.0.6' // pack a self contained jar
-	id 'de.undercouch.download' version '4.1.1'
+	id 'com.diffplug.spotless' version '6.1.0'//code format
+	id 'com.github.spotbugs' version '5.0.3' // code check, working on byte code
+	id 'de.undercouch.download' version '4.1.2'
 	id 'kr.motd.sphinx' version '2.10.1' // documentation generation
 	id 'jacoco' // java code coverage plugin
-	id "org.sonarqube" version "3.2.0" // sonarqube
+	id "org.sonarqube" version "3.3" // sonarqube
 	id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
 }
 
 ext {
 	//version (changing these should be considered thoroughly!)
 	javaVersion = JavaVersion.VERSION_1_8
 	tscfgVersion = '0.9.9'
-	testcontainersVersion = '1.15.3'
+	testcontainersVersion = '1.16.2'
 
 	scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
@@ -33,7 +32,6 @@ apply from: scriptsLocation + 'pmd.gradle'
 apply from: scriptsLocation + 'spotbugs.gradle'
 apply from: scriptsLocation + 'spotless.gradle'
 apply from: scriptsLocation + 'checkJavaVersion.gradle'
-apply from: scriptsLocation + 'selfContainedJar.gradle'
 apply from: scriptsLocation + 'documentation.gradle'
 apply from: scriptsLocation + 'jacoco.gradle' // jacoco java code coverage
 apply from: scriptsLocation + 'mavenCentralPublish.gradle'
@@ -46,48 +44,47 @@ repositories {
 	maven { url 'https://www.jitpack.io' } // allows github repos as dependencies
 
 	// sonatype snapshot repo
-	maven { url 'http://oss.sonatype.org/content/repositories/snapshots' }
+	maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
 
 }
 
 dependencies {
 	//	 ie³ power system utils
-	compile 'com.github.ie3-institute:PowerSystemUtils:1.5.2'
+	implementation 'com.github.ie3-institute:PowerSystemUtils:1.5.3'
 
 	implementation 'tech.units:indriya:2.1.2'
 
 	// JTS Topology Suite for GeoPositions, License: EPL 1.0 / EDL 1.0
-	compile 'org.locationtech.jts:jts-core:1.18.1'
-	compile 'org.locationtech.jts.io:jts-io-common:1.18.1'
+	implementation 'org.locationtech.jts:jts-core:1.18.2'
+	implementation 'org.locationtech.jts.io:jts-io-common:1.18.2'
 
 	// Graphs
-	compile 'org.jgrapht:jgrapht-core:1.4.0'
+	implementation 'org.jgrapht:jgrapht-core:1.4.0'
 
 	// testing
-	testCompile 'org.junit.jupiter:junit-jupiter:5.7.2'
-	testCompile 'org.spockframework:spock-core:2.0-groovy-3.0'
-	testCompile 'org.objenesis:objenesis:3.2' // Mock creation with constructor parameters
+	testImplementation 'org.junit.jupiter:junit-jupiter:5.8.2'
+	testImplementation 'org.spockframework:spock-core:2.0-groovy-3.0'
+	testImplementation 'org.objenesis:objenesis:3.2' // Mock creation with constructor parameters
 
 	// testcontainers (docker framework for testing)
-	testCompile "org.testcontainers:testcontainers:$testcontainersVersion"
-	testCompile "org.testcontainers:spock:$testcontainersVersion"
-	testCompile "org.testcontainers:influxdb:$testcontainersVersion"
-	testCompile "org.testcontainers:postgresql:$testcontainersVersion"
-	testCompile "org.testcontainers:couchbase:$testcontainersVersion"
+	testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
+	testImplementation "org.testcontainers:spock:$testcontainersVersion"
+	testImplementation "org.testcontainers:influxdb:$testcontainersVersion"
+	testImplementation "org.testcontainers:postgresql:$testcontainersVersion"
+	testImplementation "org.testcontainers:couchbase:$testcontainersVersion"
 
 	// logging
-	compile 'org.apache.logging.log4j:log4j-api:2.14.1' // log4j
-	compile 'org.apache.logging.log4j:log4j-core:2.14.1' // log4j
-	compile 'org.apache.logging.log4j:log4j-slf4j-impl:2.14.1' // log4j -> slf4j
+	implementation 'org.apache.logging.log4j:log4j-api:2.17.1' // log4j
+	implementation 'org.apache.logging.log4j:log4j-core:2.17.1' // log4j
+	implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.17.1' // log4j -> slf4j
 
 	// Databases
-	compile 'org.influxdb:influxdb-java:2.21'
-	compile 'com.couchbase.client:java-client:3.1.5'
-	runtimeOnly 'org.postgresql:postgresql:42.2.20' // postgresql jdbc driver required during runtime
+	implementation 'org.influxdb:influxdb-java:2.22'
+	implementation 'com.couchbase.client:java-client:3.2.4'
+	runtimeOnly 'org.postgresql:postgresql:42.3.1' // postgresql jdbc driver required during runtime
 
-
-	compile 'commons-io:commons-io:2.8.0' // I/O functionalities
-	compile 'org.apache.commons:commons-compress:1.20' // I/O functionalities
+	implementation 'commons-io:commons-io:2.11.0' // I/O functionalities
+	implementation 'org.apache.commons:commons-compress:1.21' // I/O functionalities
 }
 
 wrapper {
@@ -98,6 +95,10 @@ tasks.withType(JavaCompile) {
 	options.encoding = 'UTF-8'
 }
 
+tasks.withType(Javadoc){
+	options.encoding = 'UTF-8'
+}
+
 task printVersion {
 	doLast {
 		println project.version

diff --git a/docs/readthedocs/gettingstarted.rst b/docs/readthedocs/gettingstarted.rst
@@ -25,7 +25,7 @@ On `Maven central <https://search.maven.org/artifact/com.github.ie3-institute/Po
    <dependency>
      <groupId>com.github.ie3-institute</groupId>
      <artifactId>PowerSystemDataModel</artifactId>
-     <version>1.1.0</version>
+     <version>2.0.0</version>
    </dependency>
 
 Snapshot releases

diff --git a/docs/readthedocs/models/input/grid/line.rst b/docs/readthedocs/models/input/grid/line.rst
@@ -48,7 +48,9 @@ Entity Model
 +-------------------+------+--------------------------------------------------------+
 | nodeB             | --   |                                                        |
 +-------------------+------+--------------------------------------------------------+
-| parallelDevices   | --   | Amount of parallel devices of same attributes          |
+| parallelDevices   | --   | | overall amount of parallel lines to automatically    |
+|                   | --   | | construct (e.g. parallelDevices = 2 will build a     |
+|                   | --   | | total of two lines using the specified parameters)   |
 +-------------------+------+--------------------------------------------------------+
 | type              | --   |                                                        |
 +-------------------+------+--------------------------------------------------------+

diff --git a/docs/readthedocs/models/input/grid/transformer2w.rst b/docs/readthedocs/models/input/grid/transformer2w.rst
@@ -50,29 +50,31 @@ As obvious, the parameter can be used in T- as in 𝜋-equivalent circuit repres
 Entity Model
 """"""""""""
 
-+-----------------+------+--------------------------------------------------------+
-| Attribute       | Unit | Remarks                                                |
-+=================+======+========================================================+
-| uuid            | --   |                                                        |
-+-----------------+------+--------------------------------------------------------+
-| id              | --   | Human readable identifier                              |
-+-----------------+------+--------------------------------------------------------+
-| operator        | --   |                                                        |
-+-----------------+------+--------------------------------------------------------+
-| operationTime   | --   | Timely restriction of operation                        |
-+-----------------+------+--------------------------------------------------------+
-| nodeA           | --   | Higher voltage node                                    |
-+-----------------+------+--------------------------------------------------------+
-| nodeB           | --   | Lower voltage node                                     |
-+-----------------+------+--------------------------------------------------------+
-| parallelDevices | --   | Amount of parallel devices of same attributes          |
-+-----------------+------+--------------------------------------------------------+
-| type            | --   |                                                        |
-+-----------------+------+--------------------------------------------------------+
-| tapPos          | --   | Current position of the tap changer                    |
-+-----------------+------+--------------------------------------------------------+
-| autoTap         | --   | true, if there is a tap regulation apparent and active |
-+-----------------+------+--------------------------------------------------------+
++-----------------+------+------------------------------------------------------------+
+| Attribute       | Unit | Remarks                                                    |
++=================+======+============================================================+
+| uuid            | --   |                                                            |
++-----------------+------+------------------------------------------------------------+
+| id              | --   | Human readable identifier                                  |
++-----------------+------+------------------------------------------------------------+
+| operator        | --   |                                                            |
++-----------------+------+------------------------------------------------------------+
+| operationTime   | --   | Timely restriction of operation                            |
++-----------------+------+------------------------------------------------------------+
+| nodeA           | --   | Higher voltage node                                        |
++-----------------+------+------------------------------------------------------------+
+| nodeB           | --   | Lower voltage node                                         |
++-----------------+------+------------------------------------------------------------+
+| parallelDevices | --   | | overall amount of parallel transformers to automatically |
+|                 | --   | | construct (e.g. parallelDevices = 2 will build a         |
+|                 | --   | | total of two transformers using the specified parameters)|
++-----------------+------+------------------------------------------------------------+
+| type            | --   |                                                            |
++-----------------+------+------------------------------------------------------------+
+| tapPos          | --   | Current position of the tap changer                        |
++-----------------+------+------------------------------------------------------------+
+| autoTap         | --   | true, if there is a tap regulation apparent and active     |
++-----------------+------+------------------------------------------------------------+
 
 Caveats
 ^^^^^^^

diff --git a/docs/readthedocs/models/input/grid/transformer3w.rst b/docs/readthedocs/models/input/grid/transformer3w.rst
@@ -70,31 +70,33 @@ All impedances and admittances are given with respect to the higher voltage side
 Entity Model
 """"""""""""
 
-+-----------------+------+--------------------------------------------------------+
-| Attribute       | Unit | Remarks                                                |
-+=================+======+========================================================+
-| uuid            | --   |                                                        |
-+-----------------+------+--------------------------------------------------------+
-| id              | --   | Human readable identifier                              |
-+-----------------+------+--------------------------------------------------------+
-| operator        | --   |                                                        |
-+-----------------+------+--------------------------------------------------------+
-| operationTime   | --   | Timely restriction of operation                        |
-+-----------------+------+--------------------------------------------------------+
-| nodeA           | --   | Higher voltage node                                    |
-+-----------------+------+--------------------------------------------------------+
-| nodeB           | --   | Intermediate voltage node                              |
-+-----------------+------+--------------------------------------------------------+
-| nodeC           | --   | Lowest voltage node                                    |
-+-----------------+------+--------------------------------------------------------+
-| parallelDevices | --   | Amount of parallel devices of same attributes          |
-+-----------------+------+--------------------------------------------------------+
-| type            | --   |                                                        |
-+-----------------+------+--------------------------------------------------------+
-| tapPos          | --   | Current position of the tap changer                    |
-+-----------------+------+--------------------------------------------------------+
-| autoTap         | --   | true, if there is a tap regulation apparent and active |
-+-----------------+------+--------------------------------------------------------+
++-----------------+------+------------------------------------------------------------+
+| Attribute       | Unit | Remarks                                                    |
++=================+======+============================================================+
+| uuid            | --   |                                                            |
++-----------------+------+------------------------------------------------------------+
+| id              | --   | Human readable identifier                                  |
++-----------------+------+------------------------------------------------------------+
+| operator        | --   |                                                            |
++-----------------+------+------------------------------------------------------------+
+| operationTime   | --   | Timely restriction of operation                            |
++-----------------+------+------------------------------------------------------------+
+| nodeA           | --   | Higher voltage node                                        |
++-----------------+------+------------------------------------------------------------+
+| nodeB           | --   | Intermediate voltage node                                  |
++-----------------+------+------------------------------------------------------------+
+| nodeC           | --   | Lowest voltage node                                        |
++-----------------+------+------------------------------------------------------------+
+| parallelDevices | --   | | overall amount of parallel transformers to automatically |
+|                 | --   | | construct (e.g. parallelDevices = 2 will build a         |
+|                 | --   | | total of two transformers using the specified parameters)|
++-----------------+------+------------------------------------------------------------+
+| type            | --   |                                                            |
++-----------------+------+------------------------------------------------------------+
+| tapPos          | --   | Current position of the tap changer                        |
++-----------------+------+------------------------------------------------------------+
+| autoTap         | --   | true, if there is a tap regulation apparent and active     |
++-----------------+------+------------------------------------------------------------+
 
 Caveats
 ^^^^^^^