Release 3.0

.github/dependabot.yml

@@ -8,7 +8,22 @@ updates:
   open-pull-requests-limit: 10
   target-branch: dev
   reviewers:
-  - ckittl
-  - johanneshiry
   - t-ober
   - sensarmad
+  - sebastian-peter
+  - danielfeismann
+  ignore:
+    - dependency-name: org.scalatest:scalatest_2.13
+      versions:
+        - 3.3.0-SNAP+
+    - dependency-name: org.scalatestplus:mockito-3-4_2.13
+      versions:
+        - 3.3.0.0-SNAP+
+
+- package-ecosystem: pip
+  directory: "/docs/readthedocs"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 8
+  target-branch: dev

.gitignore

@@ -225,9 +225,10 @@ output
 deploy.properties
 
 # pv model it data
-!src/test/resources/**/it-data
+!src/test/resources/**/it
 
 # avoid ignoring test jars
 !src/test/resources/**/*.jar
+
 # Ignore Gradle build output directory
 build

.readthedocs.yaml

@@ -7,9 +7,9 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.11"
 
 # Configure python
 python:
@@ -18,4 +18,5 @@ python:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/readthedocs/conf.py
+  configuration: docs/readthedocs/conf.py
+  fail_on_warning: true

AUTHORS.md

@@ -47,12 +47,18 @@ Scala and uses akka as its main library for concurrent calculation and to repres
 #### 2. Generation
 - Sen-Sarma, Debopama (DFG MoMeEnt)
 
-#### 3. Generaiton
+#### 3. Generation
 - Oberließen, Thomas (TRANSENSE)
 - Peter, Sebastian (TRANSENSE)
+- Feismann, Daniel (Redispatch 3.0)
+- Bao, Johannes (ReCoDE)
+- Hohmann, Julian (HoLa)
 
 ### Scientific Assistants
 - Krause, Mia
 - Peter, Sebastian
 - Schmahl, Maximilian
 - Zachopoulos, Vasilios
+- Staudt, Marius
+- Roumeliotis, Lara
+- Bung, Vicky

CHANGELOG.md

@@ -0,0 +1,113 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.0.0] - 2023-08-07
+
+### Added
+- Implement SQL source for primary data [#34](https://github.com/ie3-institute/simona/issues/34), [#101](https://github.com/ie3-institute/simona/issues/101)
+- Relevant scientific papers have been added to the documentation [#139](https://github.com/ie3-institute/simona/issues/139)
+- Add troubleshooting section to Users guide [#160](https://github.com/ie3-institute/simona/issues/160)
+- Added Kafka sink for results [#24](https://github.com/ie3-institute/simona/issues/24)
+- Added Kafka sink for runtime events, re-implemented RuntimeEventListener in akka typed [#242](https://github.com/ie3-institute/simona/issues/242)
+- Added listeners to DBFS tests to check the result output and check the handling of failed power flows [#269](https://github.com/ie3-institute/simona/issues/269)
+- Added DBFS test with participant load and added testing for FinishGridSimulationTrigger [#281](https://github.com/ie3-institute/simona/issues/281)
+- Added Dependabot updates to sphinx/readthedocs dependencies [#448](https://github.com/ie3-institute/simona/issues/448)
+- Check for grid validity with PSDM `ValidationUtils` [#460](https://github.com/ie3-institute/simona/issues/460)
+- Enhancing dev's guide [#363](https://github.com/ie3-institute/simona/issues/363)
+- Support PF calculation with closed switches [#474](https://github.com/ie3-institute/simona/issues/474)
+
+### Changed
+- Re-organizing test resources into their respective packages [#105](https://github.com/ie3-institute/simona/issues/105)
+- BREAKING: Using snapshot version of PSDM and PSU
+- Simplified PrimaryServiceProxy due to changes in PSDM [#120](https://github.com/ie3-institute/simona/issues/120)
+- Improved handling of weights and their sum in determination of weather data [#173](https://github.com/ie3-institute/simona/issues/173)
+- Improving code readability in EvcsAgent by moving FreeLotsRequest to separate methods [#19](https://github.com/ie3-institute/simona/issues/19)
+- Ignore dependabot snapshot dependencies [#27](https://github.com/ie3-institute/simona/issues/27)
+- Sending termination message to external simulation on expected and unexpected shutdowns of SIMONA [#35](https://github.com/ie3-institute/simona/issues/35)
+- Change transformer calculation since changes in PSDM [#99](https://github.com/ie3-institute/simona/issues/99)
+- Adapt to changed PvInputModel of PSDM (elevationAngle) [#100](https://github.com/ie3-institute/simona/issues/100)
+- Consolidate csv parameterization in config [#149](https://github.com/ie3-institute/simona/issues/149)
+- Change weather scheme to COSMO [PR#154](https://github.com/ie3-institute/simona/pull/154)
+- Adapt documentation to changed simonaAPI [#191](https://github.com/ie3-institute/simona/issues/191)
+- Implementing a new plugin framework for external simulations [#195](https://github.com/ie3-institute/simona/issues/195)
+- Improved implementation of `RefSystemParser` [#212](https://github.com/ie3-institute/simona/issues/212)
+- Include missing images into Documentation [#151](https://github.com/ie3-institute/simona/issues/151)
+- Changing the export methode for diagrams [#156](https://github.com/ie3-institute/simona/issues/156)
+- Change references implementation in Documentation to bibtex [#174](https://github.com/ie3-institute/simona/issues/174) 
+- Update Model descriptions (Documentation) [#122](https://github.com/ie3-institute/simona/issues/122)
+- Changes of Getting Started Section (Documentation) [#124](https://github.com/ie3-institute/simona/issues/124) 
+- Update gradle [#176](https://github.com/ie3-institute/simona/issues/176)
+- Setting java version to 17 [#58](https://github.com/ie3-institute/simona/issues/58)
+- Made SimonaConfig.BaseRuntimeConfig serializable [#36](https://github.com/ie3-institute/simona/issues/36)
+- Adapt to new simonaAPI snapshot [#95](https://github.com/ie3-institute/simona/issues/95)
+- Update Sphinx to 4.5.0 as well as extensions [#214](https://github.com/ie3-institute/simona/issues/214)
+- Improved code quality in and around DBFS algorithm [#265](https://github.com/ie3-institute/simona/issues/265)
+- Adapt test to new PowerSystemUtils snapshot  [#294](https://github.com/ie3-institute/simona/issues/294)
+- Simplified ParticipantConfigUtil [#273](https://github.com/ie3-institute/simona/issues/273)
+- Consolidated and enhanced SimScheduler tests [#285](https://github.com/ie3-institute/simona/issues/285)
+- Renaming sub-package directories [#141](https://github.com/ie3-institute/simona/issues/141)
+- Updated authors in AUTHORS.md [#301](https://github.com/ie3-institute/simona/issues/301)
+- Added faster data structures to SimScheduler [#282](https://github.com/ie3-institute/simona/issues/282)
+- Adaption of abbreviations in PVModel and adjacent classes to naming convention [#326](https://github.com/ie3-institute/simona/issues/326)
+- Fixed Latex equations [#264](https://github.com/ie3-institute/simona/issues/264)
+- Documentation of the simulation configuration [#334](https://github.com/ie3-institute/simona/issues/334)
+- Adapted to changes of Quantity units in PSU and PSDM [#419](https://github.com/ie3-institute/simona/pull/419)
+- Adapted entry in Done message and deleted parallel window [#159](https://github.com/ie3-institute/simona/issues/159)
+- Added ConfigFailFast check for invalid dateTime configuration [#344](https://github.com/ie3-institute/simona/issues/344)
+- Changed simulation duration format [#429](https://github.com/ie3-institute/simona/issues/429)
+- Updated sphinx dependencies and fixed sphinx warnings [#444](https://github.com/ie3-institute/simona/issues/444)
+- Updated authors in AUTHORS.md and README.md [#452](https://github.com/ie3-institute/simona/issues/452)
+- Updating `CONTRIBUTING.md` [#201](https://github.com/ie3-institute/simona/issues/201)
+- Speeding up additionalActivationTicks in participant's BaseStateData [#421](https://github.com/ie3-institute/simona/pull/421)
+- Changed format of example grid `vn_simona` [#216](https://github.com/ie3-institute/simona/issues/216)
+- Renamed ChpData to ChpRelevantData [#494](https://github.com/ie3-institute/simona/issues/494)
+- Updated gradle to 8.2.1, cleaned up `build.gradle` and `Jenkinsfile` [#572](https://github.com/ie3-institute/simona/issues/572)
+
+### Fixed
+- Location of `vn_simona` test grid (was partially in Berlin and Dortmund) [#72](https://github.com/ie3-institute/simona/issues/72)
+- Let `ParticipantAgent` die after failed registration with secondary services (prevents stuck simulation) [#76](https://github.com/ie3-institute/simona/issues/76)
+- Fix default resolution of weather source wrapper [#78](https://github.com/ie3-institute/simona/issues/78)
+- Fix invalid thread allocation in GridAgent [#111](https://github.com/ie3-institute/simona/issues/111)
+- Fixed config auto-generation [#130](https://github.com/ie3-institute/simona/issues/130)
+- Fixed genConfigSample gradle task[#148](https://github.com/ie3-institute/simona/issues/148)
+- Fixed some unreachable code [#167](https://github.com/ie3-institute/simona/issues/167)
+- Fix treatment of non-InitializeTrigger triggers in initialization within SimScheduler [#237](https://github.com/ie3-institute/simona/issues/237)
+- Fix breaking SIMONA caused by introducing temperature dependant load profiles in PSDM [#255](https://github.com/ie3-institute/simona/issues/255)
+- Respect for voltage angle in DBFS slack voltage exchange protocol [#69](https://github.com/ie3-institute/simona/issues/69)
+- Adapted to changed time series interfaces in PSDM [#296](https://github.com/ie3-institute/simona/issues/296)
+- Fix handling of multiple connections between subgrids [#22](https://github.com/ie3-institute/simona/issues/22)
+  - Consolidate request replies for different sub grid gates in one message
+  - Await and send responses for distinct pairs of sender reference and target node
+- Removed deprecations from `CsvGridSource` and added `TestGridFactory` [#304](https://github.com/ie3-institute/simona/issues/304)
+- Removed grid config for vn_146_lv_small [#290](https://github.com/ie3-institute/simona/issues/290)
+- Adapted to changes of EvcsInput in PSDM [#377](https://github.com/ie3-institute/simona/pull/377)
+- Fix breaking SIMONA caused by changes in simonaAPI [#384] (https://github.com/ie3-institute/simona/issues/384)
+- Fixed awaiting departed EVs in ExtEvDataService [#392](https://github.com/ie3-institute/simona/issues/392)
+- Fixed missing ModelBaseStateData generation for random load profiles [#399](https://github.com/ie3-institute/simona/issues/399)
+- Fixed non-random first days of random load profiles [#401](https://github.com/ie3-institute/simona/issues/401)
+- Fixed groovy formatting [#110](https://github.com/ie3-institute/simona/issues/110)
+- Fixed configuration reference in user's guide [#224](https://github.com/ie3-institute/simona/issues/224)
+- Fixed ResultEventListener exiting too early with high volumes of results [#350](https://github.com/ie3-institute/simona/issues/350)
+- Fixed tests that unreliably fail [#359](https://github.com/ie3-institute/simona/issues/359)
+- Support for three winding transformers  [#63](https://github.com/ie3-institute/simona/issues/63)
+  - Handle incoming slack voltage accordingly
+  - Allow multiple sub grid gates at one node (also allows multiple two winding transformers at one node)
+  - Perform power flow calculation in highest grid, if a three winding transformer is apparent
+  - Write out results
+- Fixed broken layout in RTD documentation [#500](https://github.com/ie3-institute/simona/issues/500)
+- Corrected tests in RefSystemTest [#560](https://github.com/ie3-institute/simona/issues/560)
+- Take log file event filters from `logback.xml` when defining the run log appender [#108](https://github.com/ie3-institute/simona/issues/108)
+
+### Removed
+- Remove workaround for tscfg tmp directory [#178](https://github.com/ie3-institute/simona/issues/178)
+- Removed Gradle task puml2png (Converting Plantuml to png / svg files) since it is no longer needed  [#228](https://github.com/ie3-institute/simona/issues/228)
+- Remove RocketChat notification from Jenkinsfile [#234](https://github.com/ie3-institute/simona/issues/234)
+- Removed one-jar gradle plugin [#564](https://github.com/ie3-institute/simona/issues/564)
+
+[Unreleased]: https://github.com/ie3-institute/simona/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/ie3-institute/simona/compare/a14a093239f58fca9b2b974712686b33e5e5f939...3.0.0

CONTRIBUTING.md

@@ -7,16 +7,12 @@ With this document we would like to give you some orientation on how you can con
 * [Testing and reporting bugs](#testing-and-reporting-bugs)
 * [Suggest extensions](#suggest-extensions)
 * [Contributing code](#contributing-code)
-* [Branching and handing in pull requests](#branching-and-handing-in-pull-requests)
-* [General (software) design guidelines](#general-software-design-guidelines)
-* [Testing](#testing)
-* [Finalising your pull request](#finalising-your-pull-request)
-* [For any doubts](#for-any-doubts)
+* [With any questions or doubts](#with-any-questions-or-doubts)
 
 ## Testing and reporting bugs
 We really appreciate your usage of this project.
 Whenever you find a bug, it would be nice to check, if this isn't a feature to us. :wink:
-If you still think it's a bug, please raise an [issue](https://simona.ie3.e-technik.tu-dortmund.de/jira/projects/SIM/issues/) for us.
+If you still think it's a bug, please [raise an issue](https://github.com/ie3-institute/simona/issues) for us.
 Considering the following aspects in your inquiry, assists us in helping you:
 
 * **Is there already an issue addressing your problem?**
@@ -31,45 +27,12 @@ We use issues as well to keep track of enhancement suggestions.
 Considering the following aspects, assists us in understanding your needs properly:
 
 * **Is there already an issue addressing your request?**
-* **What would do you desire for?**
 * If possible provide an **example or sketch**.
 * Show a **use case**, that should be as versatile as possible.
 * Mark the issue with the **label _enhancement_**.
 
 ## Contributing code
-If you intend to produce some lines of code, pick an issue and get some hands on! For any questions feel
-free to contact us.
+Please refer to our [developer's guide](https://simona.readthedocs.io/en/latest/developersguide.html) for more information on how to contribute code.
 
-### Branching and handing in pull requests
-We try to follow a branch naming strategy of the form `<initials>/#<issueId>-<description>`.
-If for example [Prof. Dr. rer. hort. Klaus-Dieter Brokkoli](https://www.instagram.com/prof_broccoli/) would like to add some work on node models reported in issue 4711, he would open a branch `kb/#4711-extendingNodeModels`.
-Please hand in a pull request with ``WIP:`` prefix as early as possible to allow other to keep track on your changes.
-Before opening it for review, please [finalise your pull request](#finalising-your-pull-request).
-
-### General (software) design guidelines
-In order to maintain a consistent project, we thought of some general design guidlines, we kindly ask you to take care of:
-
-* We :heart: **immutability**. Therefore, please don't provide setters and use proper instantiation instead.
-* `double a = b * pow(x, j)`? :hand: Please **be expressive** in what you code!
-* Document your code with **scaladoc**.
-
-### Testing
-Ensure the proper function of your code by [test driven development (TDD)](https://www.guru99.com/test-driven-development.html).
-We have good experiences using [ScalaTest](scalatest.org) and [Spock](http://spockframework.org/) as a testing framework for [Groovy](https://groovy-lang.org/).
-
-### Finalising your pull request
-Some automated checks assist us in delivering a pretty fair quality of software.
-Before marking the pull request as 'ready to review', take these precautionary actions:
-
-* Are all tests passing? Run `gradle allTests` or comment `!test` in your PR which automatically triggers
-our [CI](https://tvnws007-lin.ie3.e-technik.tu-dortmund.de/job/simona/)
-* Is your code properly formatted? Run `gradle spotlessApply`
-* Update the javadoc pages. Run `gradle genJavadoc`
-
-## For any doubts
-... please contact
-* Johannes ([[email protected]](mailto:[email protected])),
-* Debopama ([[email protected]](mailto:[email protected])) or
-* Chris ([[email protected]](mailto:[email protected]))
-
-We are happy to help! :smiley:
+## With any questions or doubts
+... please contact the developers listed in the [README.md](https://github.com/ie3-institute/simona/blob/dev/README.md).

Dockerfile

@@ -0,0 +1,25 @@
+FROM openjdk:17-slim
+
+# USAGE:
+# build with ARG version and if applicable with ARG snapshot suffix
+    # e.g.: docker build --build-arg version=2.1.0 --build-arg snapshotSuffix=-SNAPSHOT -t simona .
+# run by mounting directory
+    # e.g. docker run -v `realpath input`:/input --rm simona
+        # note: this does not work for windows so you have to enter the absolute path manually and escape the \'s
+
+ARG version
+# snapshot suffix for jar files is "-SNAPSHOT"
+ARG snapshotSuffix=""
+
+ENV jarFile="simona-${version}${snapshotSuffix}-all.jar"
+ENV config=""
+
+RUN mkdir exec \
+  && mkdir input
+
+# copy simona fat jar into container
+COPY build/libs/$jarFile /exec/
+# inputData is mounted upon running
+VOLUME /input
+
+ENTRYPOINT ["sh", "-c", "java -jar exec/${jarFile} --config=${config}"]