Skip to content
Merged
Show file tree
Hide file tree
Changes from 72 commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
22a6fee
Improving implementation of idCoordinateSource.
staudtMarius Oct 27, 2022
116d351
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Oct 27, 2022
acf9a5d
Improving code.
staudtMarius Oct 28, 2022
e424f0d
Merge remote-tracking branch 'origin/ms/#689-improving-implementation…
staudtMarius Oct 28, 2022
6e8025c
fmt
staudtMarius Oct 28, 2022
d879543
Adding some documentation.
staudtMarius Oct 28, 2022
a2d2faf
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Oct 31, 2022
d4d3156
Implementing some tests.
staudtMarius Oct 31, 2022
00c21f2
Adding missing file for SqlIdCoordinateSource test.
staudtMarius Oct 31, 2022
a19ff9f
fmt
staudtMarius Oct 31, 2022
354fc4a
fmt
staudtMarius Oct 31, 2022
9b59372
fmt
staudtMarius Oct 31, 2022
344d6fb
Some refactoring.
staudtMarius Nov 2, 2022
2644931
Implementing changes in CsvIdCoordinateSource.
staudtMarius Nov 3, 2022
c83873b
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Nov 7, 2022
f0ca780
Adding some tests.
staudtMarius Nov 7, 2022
529bee2
Adding requested changes.
staudtMarius Nov 8, 2022
9613ba9
Adding requested changes.
staudtMarius Nov 8, 2022
42ff465
``SqlIdCoordinateSource`` uses ``PostGis`` now.
staudtMarius Nov 15, 2022
975fa09
Fixing test problems.
staudtMarius Nov 15, 2022
d196187
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Nov 21, 2022
c98ed65
Implementing requested changes.
staudtMarius Nov 24, 2022
69b58f4
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Nov 24, 2022
44d1f70
Fixing ``Codacy`` error.
staudtMarius Nov 24, 2022
e3f5fee
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Nov 28, 2022
46476de
Updating code to use new method of ``PSU``.
staudtMarius Nov 28, 2022
ab993c2
Merge remote-tracking branch 'origin/ms/#689-improving-implementation…
staudtMarius Nov 28, 2022
d359718
Updating code to use new method of ``PSU``.
staudtMarius Nov 28, 2022
c7fa204
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
sebastian-peter Dec 9, 2022
ca6a2f7
Implementing requested changes.
staudtMarius Jan 9, 2023
c6768ec
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Jan 9, 2023
6c2c789
fmt
staudtMarius Jan 9, 2023
fbcfed4
Fixing failing test.
staudtMarius Jan 10, 2023
613ce64
Improving IdCoordinateSource documentation
staudtMarius Jan 12, 2023
f9b8c2f
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Jan 12, 2023
cd0993b
Fixing failing test.
staudtMarius Jan 12, 2023
4070b13
fmt
staudtMarius Jan 12, 2023
aac4301
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
sebastian-peter Jan 20, 2023
f956731
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
sebastian-peter Jan 25, 2023
b4bd815
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Feb 2, 2023
e5e5d15
Improving documentation.
staudtMarius Feb 2, 2023
e6860e4
Adding markdown support to docs.
staudtMarius Feb 7, 2023
7e0dc92
Fix conf.py
staudtMarius Feb 7, 2023
b46a15a
Fixing markdown table rendering.
staudtMarius Feb 8, 2023
9732383
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Feb 14, 2023
54d6e45
Merging `dev` changes.
staudtMarius Feb 14, 2023
f3ed621
Fixing ``readthedoc``.
staudtMarius Feb 14, 2023
2dbb6e2
Fixing ``readthedoc``.
staudtMarius Feb 15, 2023
34faee4
Fixing ``readthedoc``.
staudtMarius Feb 15, 2023
76d9f49
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Feb 17, 2023
b7cee23
Some documentation improvements.
staudtMarius Feb 17, 2023
b6c2029
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Feb 20, 2023
bf23b8c
Resolving sonatype issues.
staudtMarius Feb 20, 2023
b0a0ec2
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Feb 20, 2023
eaa51f0
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Mar 9, 2023
d873354
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Apr 11, 2023
b93afed
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Apr 14, 2023
45d10ab
Implementing requested changes.
staudtMarius Apr 14, 2023
71e02e3
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Apr 18, 2023
bc1c713
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Apr 24, 2023
5e19cd6
fmt
staudtMarius Apr 24, 2023
13bbc45
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Apr 24, 2023
a3455c0
Indentation
sebastian-peter Apr 24, 2023
377cc32
Updating readthedocs online build config
sebastian-peter Apr 24, 2023
cabc9f0
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius Apr 27, 2023
64f17b3
Implementing requested changes.
staudtMarius Apr 27, 2023
6885b36
Fixing documentation issues.
staudtMarius May 2, 2023
5f124b0
Fixing documentation issues.
staudtMarius May 2, 2023
78e3aa2
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius May 4, 2023
85ae7f0
Implementing requested documentation changes.
staudtMarius May 4, 2023
6841c3e
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius May 9, 2023
ee15cf3
Merge branch 'dev' into ms/#689-improving-implementation-of-ÍdCoordin…
staudtMarius May 15, 2023
3a1142c
Implementing requested changes.
staudtMarius May 16, 2023
7e9c6e6
fmt
staudtMarius May 16, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Copy methods for container classes [#726](https://github.com/ie3-institute/PowerSystemDataModel/issues/726)
- Allow hierarchic grid structure for JointGridContainer [#768](https://github.com/ie3-institute/PowerSystemDataModel/issues/768)
- Adding SQL id coordinate sources (``IdCoordinateSource``) [#689](https://github.com/ie3-institute/PowerSystemDataModel/issues/689)

### Fixed
- Fixed wrong rated power unit hint [#804](https://github.com/ie3-institute/PowerSystemDataModel/issues/804)
Expand Down
17 changes: 9 additions & 8 deletions docs/readthedocs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
# -- Project information -----------------------------------------------------

project = 'PowerSystemDataModel'
copyright = u'2020. TU Dortmund University, Institute of Energy Systems, Energy Efficiency and Energy Economics, Research group Distribution grid planning and operation '
copyright = 'ie3'
author = 'Johannes Hiry, Debopama Sen Sarma, Chris Kittl'

# The full version, including alpha/beta/rc tags
version = '1.0'
release = '1.0.1-SNAPSHOT'
version = '3.0.0'
release = '4.0-SNAPSHOT'

pygments_style = 'tango'
add_function_parentheses = True
Expand All @@ -35,12 +35,12 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark',
'sphinx.ext.autosectionlabel'
'sphinx.ext.intersphinx',
'myst_parser'
]

# Prefix all autogenerated labels wit the document to get unique labels (e.g. `index:Hello`)
autosectionlabel_prefix_document = True
myst_enable_extensions = ["dollarmath", "amsmath"]
myst_heading_anchors = 4

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -49,7 +49,8 @@
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv']

exclude_trees = ['.build']
source_suffix = ['.rst', '.md']
source_encoding = 'utf-8-sig'

# -- Options for HTML output -------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,32 +1,26 @@
****************
Validation Utils
****************
# Validation Utils
This page gives an overview about the ValidationUtils in the *PowerSystemDataModel*.

What are the ValidationUtils?
=============================
## What are the ValidationUtils?
The methods in ValidationUtils and subclasses can be used to check that objects are valid, meaning their parameters have valid values and they are correctly connected.

What is checked?
================
## What is checked?
- The check methods include checks that assigned values are valid, e.g. lines are not allowed to have negative lengths or the rated power factor of any unit must be between 0 and 1.
- Furthermore, several connections are checked, e.g. that lines only connect nodes of the same voltage level or that the voltage levels indicated for the transformer sides match the voltage levels of the nodes they are connected to.

How does it work?
=================
- The method :code:`ValidationUtils.check(Object)` is the only method that should be called by the user.
## How does it work?
- The method `ValidationUtils.check(Object)` is the only method that should be called by the user.
- This check method identifies the object class and forwards it to a specific check method for the given object
- The overall structure of the ValidationUtils methods follows a cascading scheme, orientated along the class tree
- Example: A :code:`LineInput lineInput` should be checked
1. :code:`ValidationUtils.check(lineInput)` is called
2. :code:`ValidationUtils.check(lineInput)` identifies the class of the object as :code:`AssetInput` and calls :code:`ValidationUtils.checkAsset(lineInput)`
3. :code:`ValidationUtils.checkAsset(lineInput)`, if applicable, checks those parameters that all :code:`AssetInput` have in common (e.g. operation time) and further identifies the object, more specifically, as a :code:`ConnectorInput` and calls :code:`ConnectorValidationUtils.check(lineInput)`
4. :code:`ConnectorValidationUtils.check(lineInput)`, if applicable, checks those parameters that all :code:`ConnectorInput` have in common and further identifies the object, more specifically, as a :code:`LineInput` and calls :code:`ConnectorValidationUtils.checkLine(lineInput)`
5. :code:`ConnectorValidationUtils.checkLine(lineInput)` checks all specific parameters of a :code:`LineInput`
- Example: A `LineInput lineInput` should be checked
1. `ValidationUtils.check(lineInput)` is called
2. `ValidationUtils.check(lineInput)` identifies the class of the object as `AssetInput` and calls `ValidationUtils.checkAsset(lineInput)`
3. `ValidationUtils.checkAsset(lineInput)`, if applicable, checks those parameters that all `AssetInput` have in common (e.g. operation time) and further identifies the object, more specifically, as a `ConnectorInput` and calls `ConnectorValidationUtils.check(lineInput)`
4. `ConnectorValidationUtils.check(lineInput)`, if applicable, checks those parameters that all `ConnectorInput` have in common and further identifies the object, more specifically, as a `LineInput` and calls `ConnectorValidationUtils.checkLine(lineInput)`
5. `ConnectorValidationUtils.checkLine(lineInput)` checks all specific parameters of a `LineInput`
- ValidationUtils furthermore contains several utils methods used in the subclasses

Which objects are checked?
==========================
## Which objects are checked?
The ValidationUtils include validation checks for...

- NodeValidationUtils
Expand Down Expand Up @@ -80,8 +74,7 @@ The ValidationUtils include validation checks for...
- RawGridElements
- SystemParticipants

What should be considered?
==========================
## What should be considered?
- Due to many checks with if-conditions, the usage of the ValidationUtils for many objects might be runtime relevant.
- The check for a GridContainer includes the interplay of the contained entities as well as the checks of all contained entities.
- If new classes are introduced to the *PowerSystemDataModel*, make sure to follow the forwarding structure of the ValidationUtils methods when writing the check methods!
5 changes: 3 additions & 2 deletions docs/readthedocs/io/basiciousage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Therefore, the I/O-package is structured as highly modular.
.. toctree::
:maxdepth: 2

influxdb
csvfiles

sql
influxdb
ValidationUtils.md


Data sink structure
Expand Down
Loading