Merge branch 'dev' into ms/#795-remove-support-for-old-csv-format

# Conflicts:
#	CHANGELOG.md
#	docs/readthedocs/gettingstarted.md

Author: staudtMarius

AUTHORS

@@ -1,10 +1,14 @@
-Copyright (c) 2023, Institute of Energy Systems, Energy Efficiency and Energy Economics (ie3)
+Copyright (c) 2024, Institute of Energy Systems, Energy Efficiency and Energy Economics (ie3)
 All rights reserved.
 
 Lead Developers:
     - Johannes Hiry
     - Chris Kittl
     - Debopama Sen-Sarma
+    - Thomas Oberließen
+    - Daniel Feismann
+    - Johannes Bao
+    - Sebastian Peter
 
 Main Contributers:
     - Johannes Hiry - https://github.com/johanneshiry
@@ -20,3 +24,8 @@ Main Contributers:
     - Marius Staudt - https://github.com/staudtMarius
     - Lara Roumeliotis - https://github.com/lararou
     - Vicky Bung - https://github.com/vickybung1
+    - Daniel Feismann - https://github.com/danielfeismann
+    - Johannes Bao - https://github.com/jo-bao
+    - Julian Hohmann - https://github.com/julianhohmann
+    - Simon Huette - https://github.com/SimonHuette
+    - Pierre Petersmeier - http://github.com/pierrepetersmeier

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Fixed Couchbase integration tests that randomly failed [#755](https://github.com/ie3-institute/PowerSystemDataModel/issues/755)
 - Fixed hyperlink in line documentation [#965](https://github.com/ie3-institute/PowerSystemDataModel/issues/965)
+- Fixed some tests no failing when they should [#958](https://github.com/ie3-institute/PowerSystemDataModel/issues/958)
 
 ### Changed
 - Changing from comparing strings to comparing uuids in `EntitySource.findFirstEntityByUuid` [#829](https://github.com/ie3-institute/PowerSystemDataModel/issues/829)
@@ -23,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allowing for additional unused columns in sources [#839](https://github.com/ie3-institute/PowerSystemDataModel/issues/839)
 - Improving column name validation to only run once per source [#849](https://github.com/ie3-institute/PowerSystemDataModel/issues/849)
 - Refactored and abstracted `EntitySource`s and `EntityData` creation [#969](https://github.com/ie3-institute/PowerSystemDataModel/issues/969)
+- Updated contributing.md [#737](https://github.com/ie3-institute/PowerSystemDataModel/issues/737)
 - Removing the support for the old csv format that was marked `deprecated` back in version `1.1.0` [#795](https://github.com/ie3-institute/PowerSystemDataModel/issues/795)
 
 ## [4.1.0] - 2023-11-02
@@ -47,6 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Fixed wrong rated power unit hint [#804](https://github.com/ie3-institute/PowerSystemDataModel/issues/804)
 - Fixed wrong hash code generation of ConnectorResult [#817](https://github.com/ie3-institute/PowerSystemDataModel/issues/817) 
+- Fixed wrong path for timeSeriesMapping [#886](https://github.com/ie3-institute/PowerSystemDataModel/issues/886)
 
 ### Changed
 - Removing deprecated classes and methods [#540](https://github.com/ie3-institute/PowerSystemDataModel/issues/540)
@@ -55,6 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Use nio paths instead of strings for file path [#723](https://github.com/ie3-institute/PowerSystemDataModel/issues/723)
 - Data source will throw an exceptions instead of returning an empty optionals [#707](https://github.com/ie3-institute/PowerSystemDataModel/issues/707)
 - Improving `ValidationUtils` [#758](https://github.com/ie3-institute/PowerSystemDataModel/issues/758)
+- conversion from rst to markdown myst[#979](https://github.com/ie3-institute/PowerSystemDataModel/pull/985)
 
 ## [3.0.0] - 2023-02-16
 

CONTRIBUTING.md

@@ -16,7 +16,7 @@ With this document we would like to give you some orientation on how you can con
 ## 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:
-You may find extensive information about the intended behaviour when you [Read the Docs](https://powersystemdatamodel.readthedocs.io/en/latest/) or within the [javadoc](https://ie3-institute.github.io/PowerSystemDataModel/javadoc/).
+You may find extensive information about the intended behaviour when you [Read the Docs](https://powersystemdatamodel.readthedocs.io/en/latest/).
 If you still think it's a bug, please raise an [issue](https://guides.github.com/features/issues/) for us.
 Considering the following aspects in your inquiry, assists us in helping you:
 
@@ -67,9 +67,6 @@ Before marking the pull request as 'ready to review', take these precautionary a
 `gradle finalizePR` summarizes all of these steps .
 
 ## For any doubts
-... please contact
-* Johannes (@johanneshiry),
-* Debopama (@sensarmad) or
-* Chris (@ckittl)
+... please contact [us](AUTHORS)
 
 We are happy to help! :smiley:

build.gradle

@@ -4,8 +4,8 @@ plugins {
   id 'maven-publish'
   id 'signing'
   id 'pmd' // code check, working on source code
-  id 'com.diffplug.spotless' version '6.24.0' //code format
-  id 'com.github.spotbugs' version '5.2.5' // code check, working on byte code
+  id 'com.diffplug.spotless' version '6.25.0' //code format
+  id 'com.github.spotbugs' version '6.0.7' // code check, working on byte code
   id 'de.undercouch.download' version '5.5.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
@@ -18,7 +18,7 @@ ext {
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
   groovyBinaryVersion = "4.0.18"
-  testcontainersVersion = '1.19.3'
+  testcontainersVersion = '1.19.4'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }

docs/readthedocs/gettingstarted.md

@@ -5,45 +5,47 @@ If you feel, something is missing, please contact us!
 
 
 ## Requirements
+
 Java > v 17
 
 ## Where to get
 
-Checkout latest from `GitHub <https://github.com/ie3-institute/PowerSystemDataModel>`_ or use maven for dependency
+Checkout latest from [GitHub](https://github.com/ie3-institute/PowerSystemDataModel) or use maven for dependency
 management:
 
 ### Stable releases
-On `Maven central <https://search.maven.org/artifact/com.github.ie3-institute/PowerSystemDataModel>`_:
 
-``` xml
-    <dependency>
-     <groupId>com.github.ie3-institute</groupId>
-     <artifactId>PowerSystemDataModel</artifactId>
-     <version>2.1.0</version>
-   </dependency>
- 
- ```
+On [Maven central](https://search.maven.org/artifact/com.github.ie3-institute/PowerSystemDataModel):
+
+```xml
+<dependency>
+  <groupId>com.github.ie3-institute</groupId>
+  <artifactId>PowerSystemDataModel</artifactId>
+  <version>2.1.0</version>
+</dependency>
+```
 
 
 ### Snapshot releases
-Available on `OSS Sonatype <https://s01.oss.sonatype.org/>`_.
+
+Available on [OSS Sonatype](https://s01.oss.sonatype.org/).
 Add the correct repository:
 
-``` xml
-   <repositories>
-     <repository>https://s01.oss.sonatype.org/content/repositories/snapshots</repository>
-   </repositories>
- ```
+```xml
+<repositories>
+  <repository>https://s01.oss.sonatype.org/content/repositories/snapshots</repository>
+</repositories>
+```
 
 and add the dependency:
 
-``` xml
-   <dependency>
-     <groupId>com.github.ie3-institute</groupId>
-     <artifactId>PowerSystemDataModel</artifactId>
-     <version>3.0-SNAPSHOT</version>
-   </dependency>
- ```
+```xml
+<dependency>
+  <groupId>com.github.ie3-institute</groupId>
+  <artifactId>PowerSystemDataModel</artifactId>
+  <version>3.0-SNAPSHOT</version>
+</dependency>
+```
 
 ## Important changes
 

docs/readthedocs/index.md

@@ -0,0 +1,34 @@
+# Documentation of the PowerSystemDataModel
+
+Welcome to the documentation of the PowerSystemDataModel.
+It provides an extensive data model capable of modelling energy systems with high granularity e.g. for bottom-up simulations.
+Additionally, useful functions to process, augment and furnish model i/o information is provided.
+Effective handling of geographic information related to power grids is also possible.
+
+```{toctree}
+:caption: 'Contents:'
+:maxdepth: 2
+
+gettingstarted
+models/models
+io/basiciousage
+```
+
+## Contact the (Main) Maintainers
+
+If you feel, something this missing, wrong or misleading, please contact one of our main contributors:
+
+> - [@sensarmad](https://github.com/sensarmad)
+> - [@t-ober](https://github.com/t-ober)
+> - [@danielfeismann](https://github.com/danielfeismann)
+> - [@sebastian-peter](https://github.com/sebastian-peter)
+> - [@jo-bao](https://github.com/jo-bao)
+> - [@julianhohmann](https://github.com/julianhohmann)
+
+Hat tip to all other contributors!
+
+# Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
+- {ref}`search`

docs/readthedocs/index.rst

@@ -1,33 +1,32 @@
-********
-InfluxDB
-********
-`InfluxDB <https://www.influxdata.com/products/influxdb-overview/>`_ is a time series database. As such, it can only
-handle time based data like weather data or results.
-The PowerSystemDataModel offers two interface implementations for InfluxDB 1.x: WeatherSource and OutputDataSink.
-
-Introduction to InfluxDB
-========================
-InfluxDB is a NoSQL database as it is neither relational nor able to handle SQL queries, even though InfluxDB's own
-QueryLanguage, `InfluxQL <https://docs.influxdata.com/influxdb/v1.8/query_language/>`_ is very similar to SQL.
-InfluxDB persists data in *measurements*. A measurement is comparable to a table in a relational data model. It consists
-of a *measurement name*, *fields*, *tags* and a *time column*. The measurement name is the equivalent of a table name. Fields
-and tags are similar as they both hold data like columns in relational data. But while fields are supposed to hold
-the actual data, tags should only hold metadata, which is why tag values can only be strings. Under default
-configuration, one tag key can only hold 10 000 distinct tag values. This choice was made as tags are indexed and
-supposed to be queried. Fields should only be queried if not avoidable. The time column is automatically provided, it
-holds timestamps in `RFC3339 UTC <https://www.ietf.org/rfc/rfc3339.txt>`_, which for example looks like
-"2020-06-22T10:14:50.52Z". The equivalent to a table row is a measurement point. It holds field and tag values as well
-as the time. While the data values are optional, a timestamp is not. If no time is provided when persisting, the current
-system time is used.
-
-Instantiating an InfluxDB DataConnector
-=======================================
-To instantiate an InfluxDbConnector a connection url, a database name and a scenario name should be provided. The
-scenario name is used to build measurement names for results.
-If none of those are provided, default values are used.
-
-.. code-block:: java
-
-    InfluxDbConnector unparameterizedInfluxDb = new InfluxDbConnector();
-    InfluxDbConnector defaultInfluxDb = new InfluxDbConnector(""http://localhost:8086/", "ie3_in", null);
-    unparameterizedInfluxDb.equals(defaultInfluxDb); //true
+# InfluxDB
+
+[InfluxDB](https://www.influxdata.com/products/influxdb-overview/) is a time series database. As such, it can only
+handle time based data like weather data or results.
+The PowerSystemDataModel offers two interface implementations for InfluxDB 1.x: WeatherSource and OutputDataSink.
+
+## Introduction to InfluxDB
+
+InfluxDB is a NoSQL database as it is neither relational nor able to handle SQL queries, even though InfluxDB's own
+QueryLanguage, [InfluxQL](https://docs.influxdata.com/influxdb/v1.8/query_language/) is very similar to SQL.
+InfluxDB persists data in *measurements*. A measurement is comparable to a table in a relational data model. It consists
+of a *measurement name*, *fields*, *tags* and a *time column*. The measurement name is the equivalent of a table name. Fields
+and tags are similar as they both hold data like columns in relational data. But while fields are supposed to hold
+the actual data, tags should only hold metadata, which is why tag values can only be strings. Under default
+configuration, one tag key can only hold 10 000 distinct tag values. This choice was made as tags are indexed and
+supposed to be queried. Fields should only be queried if not avoidable. The time column is automatically provided, it
+holds timestamps in [RFC3339 UTC](https://www.ietf.org/rfc/rfc3339.txt), which for example looks like
+"2020-06-22T10:14:50.52Z". The equivalent to a table row is a measurement point. It holds field and tag values as well
+as the time. While the data values are optional, a timestamp is not. If no time is provided when persisting, the current
+system time is used.
+
+## Instantiating an InfluxDB DataConnector
+
+To instantiate an InfluxDbConnector a connection url, a database name and a scenario name should be provided. The
+scenario name is used to build measurement names for results.
+If none of those are provided, default values are used.
+
+```java
+InfluxDbConnector unparameterizedInfluxDb = new InfluxDbConnector();
+InfluxDbConnector defaultInfluxDb = new InfluxDbConnector(""http://localhost:8086/", "ie3_in", null);
+unparameterizedInfluxDb.equals(defaultInfluxDb); //true
+```

docs/readthedocs/io/influxdb.rst docs/readthedocs/io/influxdb.mddocs/readthedocs/io/influxdb.rst renamed to docs/readthedocs/io/influxdb.md

@@ -37,17 +37,49 @@ A synoptic overview of both classes' attributes is given here:
 
 ## Attributes, Units and Remarks
 
-| Attribute               | Unit | Remarks                                           |
-|:------------------------|:-----|:--------------------------------------------------|
-| gridName                | --   | Human readable identifier                         |
-| rawGrid                 | --   | see below                                         |
-| systemParticipants      | --   | see below                                         |
-| graphics                | --   | see below                                         |
-| subGridTopologyGraph    | --   | topology of sub grids - only `JointGridContainer` |
-| predominantVoltageLevel | --   | main voltage level - only `SubGridContainer`      |
-| subnet                  | --   | sub grid number - only `SubGridContainer`         |
+```{eval-rst}
+.. list-table::
+   :widths: 33 33 33
+   :header-rows: 0
 
 
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - gridName
+     - –
+     - Human readable identifier
+
+   * - rawGrid
+     - –
+     - see below
+
+   * - systemParticipants
+     - –
+     - see below
+
+   * - graphics
+     - –
+     - see below
+
+   * - subGridTopologyGraph
+     - –
+     - topology of sub grids - only
+       ``JointGridContainer``
+
+   * - predominantVoltageLevel
+     - –
+     - main voltage level - only
+       ``SubGridContainer``
+
+   * - subnet
+     - –
+     - sub grid number - only
+       ``SubGridContainer``
+
+```
+
 ### RawGridElements
 This sub container simply holds:
 
@@ -89,4 +121,4 @@ This sub container simply holds:
 
 ## Caveats
 Nothing - at least not known.
-If you found something, please contact us!
+If you found something, please contact us!