Skip to content

Commit 22694a0

Browse files
authored
Merge pull request #485 from ie3-institute/rel/jh/#484-release_v2.1.0
Release v2.1.0
2 parents 9e058b8 + 25a6254 commit 22694a0

File tree

123 files changed

+5207
-1766
lines changed

Some content is hidden

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

123 files changed

+5207
-1766
lines changed

.readthedocs.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-20.04
11+
tools:
12+
python: "3.9"
13+
14+
# Configure python
15+
python:
16+
install:
17+
- requirements: docs/readthedocs/requirements.txt
18+
19+
# Build documentation in the docs/ directory with Sphinx
20+
sphinx:
21+
configuration: docs/readthedocs/conf.py

CHANGELOG.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased/Snapshot]
88

9+
## [2.1.0] - 2022-01-05
10+
11+
### Added
12+
- added `EvcsLocationType` support in `EvcsInput` and `EvcsInputFactory` [#406](https://github.com/ie3-institute/PowerSystemDataModel/issues/406)
13+
- Opportunity to close writer in `CsvFileSink`
14+
15+
### Fixed
16+
- adapted `LineInput` constructor to convert line length to `StandardUnits.LINE_LENGTH` [#412](https://github.com/ie3-institute/PowerSystemDataModel/issues/412)
17+
18+
### Changed
19+
- Writers used to write time series are closed right away
20+
921
## [2.0.1] - 2021-07-08
1022

1123
### Fixed
@@ -14,6 +26,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1426

1527
## [2.0.0] - 2021-05-21
1628

29+
### Added
30+
- added `ResultEntitySource` interface
31+
- added `CsvResultEntitySource` implementation to read `ResultEntity` instances from .csv files
32+
- added target temperature including tolerance boundaries to `ThermalHouseInput`
33+
34+
### Changed
35+
- separated entity and file naming and introduced a new FileNamingStrategy taking an EntityNamingStrategy and a FileHierarchy as arguments
36+
37+
### Fixed
38+
- `CsvSystemParticipantSource#getSystemParticipants()` now correctly returns electric vehicle charging station input models [PR#370](https://github.com/ie3-institute/PowerSystemDataModel/pull/370)
39+
40+
## [2.0.0] - 2021-05-21
41+
1742
### Added
1843
- definition for a default input file directory structure
1944
- tarball utils to extract and compress files
@@ -94,7 +119,8 @@ coordinates or multiple exactly equal coordinates possible
94119
- CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
95120
- CsvDataSource now parsing multiple geoJson strings correctly
96121

97-
[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.1...HEAD
122+
[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.1.0...HEAD
123+
[2.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.1...2.1.0
98124
[2.0.1]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.0...2.0.1
99125
[2.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...2.0.0
100126
[1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0

Jenkinsfile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ node {
104104
// test the project
105105
stage('run tests') {
106106

107+
sh 'java -version'
108+
107109
gradle('--refresh-dependencies clean spotlessCheck pmdMain pmdTest spotbugsMain ' +
108110
'spotbugsTest test jacocoTestReport jacocoTestCoverageVerification', projectName)
109111

@@ -150,7 +152,7 @@ node {
150152
*/
151153
sh(
152154
script: """set +x && cd $projectName""" +
153-
''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk''',
155+
''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk''',
154156
returnStdout: true
155157
)
156158

@@ -706,8 +708,7 @@ def getBranchType(String branchName) {
706708
def main_pattern = ".*main"
707709
if (branchName =~ feature_pattern || branchName =~ dependabot_pattern) {
708710
return "feature"
709-
} else
710-
if (branchName =~ release_pattern) {
711+
} else if (branchName =~ release_pattern) {
711712
return "release"
712713
} else if (branchName =~ main_pattern) {
713714
return "main"

build.gradle

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@ plugins {
44
id 'maven-publish'
55
id 'signing'
66
id 'pmd' // code check, working on source code
7-
id 'com.diffplug.spotless' version '5.12.5'//code format
8-
id 'com.github.spotbugs' version '4.7.1' // code check, working on byte code
9-
id 'com.github.onslip.gradle-one-jar' version '1.0.6' // pack a self contained jar
10-
id 'de.undercouch.download' version '4.1.1'
7+
id 'com.diffplug.spotless' version '6.1.0'//code format
8+
id 'com.github.spotbugs' version '5.0.3' // code check, working on byte code
9+
id 'de.undercouch.download' version '4.1.2'
1110
id 'kr.motd.sphinx' version '2.10.1' // documentation generation
1211
id 'jacoco' // java code coverage plugin
13-
id "org.sonarqube" version "3.2.0" // sonarqube
12+
id "org.sonarqube" version "3.3" // sonarqube
1413
id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
1514
}
1615

1716
ext {
1817
//version (changing these should be considered thoroughly!)
1918
javaVersion = JavaVersion.VERSION_1_8
2019
tscfgVersion = '0.9.9'
21-
testcontainersVersion = '1.15.3'
20+
testcontainersVersion = '1.16.2'
2221

2322
scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
2423
}
@@ -33,7 +32,6 @@ apply from: scriptsLocation + 'pmd.gradle'
3332
apply from: scriptsLocation + 'spotbugs.gradle'
3433
apply from: scriptsLocation + 'spotless.gradle'
3534
apply from: scriptsLocation + 'checkJavaVersion.gradle'
36-
apply from: scriptsLocation + 'selfContainedJar.gradle'
3735
apply from: scriptsLocation + 'documentation.gradle'
3836
apply from: scriptsLocation + 'jacoco.gradle' // jacoco java code coverage
3937
apply from: scriptsLocation + 'mavenCentralPublish.gradle'
@@ -46,48 +44,47 @@ repositories {
4644
maven { url 'https://www.jitpack.io' } // allows github repos as dependencies
4745

4846
// sonatype snapshot repo
49-
maven { url 'http://oss.sonatype.org/content/repositories/snapshots' }
47+
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
5048

5149
}
5250

5351
dependencies {
5452
// ie³ power system utils
55-
compile 'com.github.ie3-institute:PowerSystemUtils:1.5.2'
53+
implementation 'com.github.ie3-institute:PowerSystemUtils:1.5.3'
5654

5755
implementation 'tech.units:indriya:2.1.2'
5856

5957
// JTS Topology Suite for GeoPositions, License: EPL 1.0 / EDL 1.0
60-
compile 'org.locationtech.jts:jts-core:1.18.1'
61-
compile 'org.locationtech.jts.io:jts-io-common:1.18.1'
58+
implementation 'org.locationtech.jts:jts-core:1.18.2'
59+
implementation 'org.locationtech.jts.io:jts-io-common:1.18.2'
6260

6361
// Graphs
64-
compile 'org.jgrapht:jgrapht-core:1.4.0'
62+
implementation 'org.jgrapht:jgrapht-core:1.4.0'
6563

6664
// testing
67-
testCompile 'org.junit.jupiter:junit-jupiter:5.7.2'
68-
testCompile 'org.spockframework:spock-core:2.0-groovy-3.0'
69-
testCompile 'org.objenesis:objenesis:3.2' // Mock creation with constructor parameters
65+
testImplementation 'org.junit.jupiter:junit-jupiter:5.8.2'
66+
testImplementation 'org.spockframework:spock-core:2.0-groovy-3.0'
67+
testImplementation 'org.objenesis:objenesis:3.2' // Mock creation with constructor parameters
7068

7169
// testcontainers (docker framework for testing)
72-
testCompile "org.testcontainers:testcontainers:$testcontainersVersion"
73-
testCompile "org.testcontainers:spock:$testcontainersVersion"
74-
testCompile "org.testcontainers:influxdb:$testcontainersVersion"
75-
testCompile "org.testcontainers:postgresql:$testcontainersVersion"
76-
testCompile "org.testcontainers:couchbase:$testcontainersVersion"
70+
testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
71+
testImplementation "org.testcontainers:spock:$testcontainersVersion"
72+
testImplementation "org.testcontainers:influxdb:$testcontainersVersion"
73+
testImplementation "org.testcontainers:postgresql:$testcontainersVersion"
74+
testImplementation "org.testcontainers:couchbase:$testcontainersVersion"
7775

7876
// logging
79-
compile 'org.apache.logging.log4j:log4j-api:2.14.1' // log4j
80-
compile 'org.apache.logging.log4j:log4j-core:2.14.1' // log4j
81-
compile 'org.apache.logging.log4j:log4j-slf4j-impl:2.14.1' // log4j -> slf4j
77+
implementation 'org.apache.logging.log4j:log4j-api:2.17.1' // log4j
78+
implementation 'org.apache.logging.log4j:log4j-core:2.17.1' // log4j
79+
implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.17.1' // log4j -> slf4j
8280

8381
// Databases
84-
compile 'org.influxdb:influxdb-java:2.21'
85-
compile 'com.couchbase.client:java-client:3.1.5'
86-
runtimeOnly 'org.postgresql:postgresql:42.2.20' // postgresql jdbc driver required during runtime
82+
implementation 'org.influxdb:influxdb-java:2.22'
83+
implementation 'com.couchbase.client:java-client:3.2.4'
84+
runtimeOnly 'org.postgresql:postgresql:42.3.1' // postgresql jdbc driver required during runtime
8785

88-
89-
compile 'commons-io:commons-io:2.8.0' // I/O functionalities
90-
compile 'org.apache.commons:commons-compress:1.20' // I/O functionalities
86+
implementation 'commons-io:commons-io:2.11.0' // I/O functionalities
87+
implementation 'org.apache.commons:commons-compress:1.21' // I/O functionalities
9188
}
9289

9390
wrapper {
@@ -98,6 +95,10 @@ tasks.withType(JavaCompile) {
9895
options.encoding = 'UTF-8'
9996
}
10097

98+
tasks.withType(Javadoc){
99+
options.encoding = 'UTF-8'
100+
}
101+
101102
task printVersion {
102103
doLast {
103104
println project.version

docs/readthedocs/gettingstarted.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ On `Maven central <https://search.maven.org/artifact/com.github.ie3-institute/Po
2525
<dependency>
2626
<groupId>com.github.ie3-institute</groupId>
2727
<artifactId>PowerSystemDataModel</artifactId>
28-
<version>1.1.0</version>
28+
<version>2.0.0</version>
2929
</dependency>
3030
3131
Snapshot releases

docs/readthedocs/models/input/grid/line.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ Entity Model
4848
+-------------------+------+--------------------------------------------------------+
4949
| nodeB | -- | |
5050
+-------------------+------+--------------------------------------------------------+
51-
| parallelDevices | -- | Amount of parallel devices of same attributes |
51+
| parallelDevices | -- | | overall amount of parallel lines to automatically |
52+
| | -- | | construct (e.g. parallelDevices = 2 will build a |
53+
| | -- | | total of two lines using the specified parameters) |
5254
+-------------------+------+--------------------------------------------------------+
5355
| type | -- | |
5456
+-------------------+------+--------------------------------------------------------+

docs/readthedocs/models/input/grid/transformer2w.rst

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -50,29 +50,31 @@ As obvious, the parameter can be used in T- as in 𝜋-equivalent circuit repres
5050
Entity Model
5151
""""""""""""
5252

53-
+-----------------+------+--------------------------------------------------------+
54-
| Attribute | Unit | Remarks |
55-
+=================+======+========================================================+
56-
| uuid | -- | |
57-
+-----------------+------+--------------------------------------------------------+
58-
| id | -- | Human readable identifier |
59-
+-----------------+------+--------------------------------------------------------+
60-
| operator | -- | |
61-
+-----------------+------+--------------------------------------------------------+
62-
| operationTime | -- | Timely restriction of operation |
63-
+-----------------+------+--------------------------------------------------------+
64-
| nodeA | -- | Higher voltage node |
65-
+-----------------+------+--------------------------------------------------------+
66-
| nodeB | -- | Lower voltage node |
67-
+-----------------+------+--------------------------------------------------------+
68-
| parallelDevices | -- | Amount of parallel devices of same attributes |
69-
+-----------------+------+--------------------------------------------------------+
70-
| type | -- | |
71-
+-----------------+------+--------------------------------------------------------+
72-
| tapPos | -- | Current position of the tap changer |
73-
+-----------------+------+--------------------------------------------------------+
74-
| autoTap | -- | true, if there is a tap regulation apparent and active |
75-
+-----------------+------+--------------------------------------------------------+
53+
+-----------------+------+------------------------------------------------------------+
54+
| Attribute | Unit | Remarks |
55+
+=================+======+============================================================+
56+
| uuid | -- | |
57+
+-----------------+------+------------------------------------------------------------+
58+
| id | -- | Human readable identifier |
59+
+-----------------+------+------------------------------------------------------------+
60+
| operator | -- | |
61+
+-----------------+------+------------------------------------------------------------+
62+
| operationTime | -- | Timely restriction of operation |
63+
+-----------------+------+------------------------------------------------------------+
64+
| nodeA | -- | Higher voltage node |
65+
+-----------------+------+------------------------------------------------------------+
66+
| nodeB | -- | Lower voltage node |
67+
+-----------------+------+------------------------------------------------------------+
68+
| parallelDevices | -- | | overall amount of parallel transformers to automatically |
69+
| | -- | | construct (e.g. parallelDevices = 2 will build a |
70+
| | -- | | total of two transformers using the specified parameters)|
71+
+-----------------+------+------------------------------------------------------------+
72+
| type | -- | |
73+
+-----------------+------+------------------------------------------------------------+
74+
| tapPos | -- | Current position of the tap changer |
75+
+-----------------+------+------------------------------------------------------------+
76+
| autoTap | -- | true, if there is a tap regulation apparent and active |
77+
+-----------------+------+------------------------------------------------------------+
7678

7779
Caveats
7880
^^^^^^^

docs/readthedocs/models/input/grid/transformer3w.rst

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -70,31 +70,33 @@ All impedances and admittances are given with respect to the higher voltage side
7070
Entity Model
7171
""""""""""""
7272

73-
+-----------------+------+--------------------------------------------------------+
74-
| Attribute | Unit | Remarks |
75-
+=================+======+========================================================+
76-
| uuid | -- | |
77-
+-----------------+------+--------------------------------------------------------+
78-
| id | -- | Human readable identifier |
79-
+-----------------+------+--------------------------------------------------------+
80-
| operator | -- | |
81-
+-----------------+------+--------------------------------------------------------+
82-
| operationTime | -- | Timely restriction of operation |
83-
+-----------------+------+--------------------------------------------------------+
84-
| nodeA | -- | Higher voltage node |
85-
+-----------------+------+--------------------------------------------------------+
86-
| nodeB | -- | Intermediate voltage node |
87-
+-----------------+------+--------------------------------------------------------+
88-
| nodeC | -- | Lowest voltage node |
89-
+-----------------+------+--------------------------------------------------------+
90-
| parallelDevices | -- | Amount of parallel devices of same attributes |
91-
+-----------------+------+--------------------------------------------------------+
92-
| type | -- | |
93-
+-----------------+------+--------------------------------------------------------+
94-
| tapPos | -- | Current position of the tap changer |
95-
+-----------------+------+--------------------------------------------------------+
96-
| autoTap | -- | true, if there is a tap regulation apparent and active |
97-
+-----------------+------+--------------------------------------------------------+
73+
+-----------------+------+------------------------------------------------------------+
74+
| Attribute | Unit | Remarks |
75+
+=================+======+============================================================+
76+
| uuid | -- | |
77+
+-----------------+------+------------------------------------------------------------+
78+
| id | -- | Human readable identifier |
79+
+-----------------+------+------------------------------------------------------------+
80+
| operator | -- | |
81+
+-----------------+------+------------------------------------------------------------+
82+
| operationTime | -- | Timely restriction of operation |
83+
+-----------------+------+------------------------------------------------------------+
84+
| nodeA | -- | Higher voltage node |
85+
+-----------------+------+------------------------------------------------------------+
86+
| nodeB | -- | Intermediate voltage node |
87+
+-----------------+------+------------------------------------------------------------+
88+
| nodeC | -- | Lowest voltage node |
89+
+-----------------+------+------------------------------------------------------------+
90+
| parallelDevices | -- | | overall amount of parallel transformers to automatically |
91+
| | -- | | construct (e.g. parallelDevices = 2 will build a |
92+
| | -- | | total of two transformers using the specified parameters)|
93+
+-----------------+------+------------------------------------------------------------+
94+
| type | -- | |
95+
+-----------------+------+------------------------------------------------------------+
96+
| tapPos | -- | Current position of the tap changer |
97+
+-----------------+------+------------------------------------------------------------+
98+
| autoTap | -- | true, if there is a tap regulation apparent and active |
99+
+-----------------+------+------------------------------------------------------------+
98100

99101
Caveats
100102
^^^^^^^

0 commit comments

Comments
 (0)