Merge pull request #962 from ie3-institute/sp/#957-spi-em

Have system participants reference their respective EMs

Author: sebastian-peter

CHANGELOG.md

@@ -23,7 +23,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Changing from comparing strings to comparing uuids in `EntitySource.findFirstEntityByUuid` [#829](https://github.com/ie3-institute/PowerSystemDataModel/issues/829)
 - Adding JavaDoc to `EntitySource.safeMapGet` [#828](https://github.com/ie3-institute/PowerSystemDataModel/issues/828)
 - Abstracting some methods in `ValidationUtils` [#852](https://github.com/ie3-institute/PowerSystemDataModel/issues/852)
-- `EmInput` should not be connected to the grid [#955](https://github.com/ie3-institute/PowerSystemDataModel/issues/955)
+- Changes to Energy Management inputs:
+  - `EmInput` should not be connected to the grid [#955](https://github.com/ie3-institute/PowerSystemDataModel/issues/955)
+  - System participants now reference the em entity [#957](https://github.com/ie3-institute/PowerSystemDataModel/issues/957)
 - Enhancing the error message for coordinate sources with invalid column names [#670](https://github.com/ie3-institute/PowerSystemDataModel/issues/670) 
 - 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)

docs/readthedocs/models/input/participant/bm.md

@@ -107,6 +107,12 @@ Model of a biomass power plant.
      - € / MWh
      - Fixed feed in tariff
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ## Caveats

docs/readthedocs/models/input/participant/chp.md

@@ -114,6 +114,12 @@ Combined heat and power plant.
      - | Whether to adapt output based on (volatile)
        | market price or not
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ## Caveats

docs/readthedocs/models/input/participant/em.md

@@ -0,0 +1,50 @@
+(em_model)=
+
+# Energy Management Unit
+
+A model of an Energy Management Unit that controls the power of connected system participants. 
+Participants are connected to an EM each via their `em` field.
+
+## Attributes, Units and Remarks
+
+```{eval-rst}
+.. list-table::
+   :widths: 33 33 33
+   :header-rows: 0
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - uuid
+     - --
+     - 
+
+   * - id
+     - --
+     - Human readable identifier
+
+   * - operator
+     - --
+     - 
+
+   * - operationTime
+     - --
+     - Timely restriction of operation
+
+   * - controlStrategy
+     - --
+     - String representation (e.g. name) of a control strategy
+
+   * - parentEm
+     - --
+     - | Reference to a superior Energy Management Unit that is controlling this EM.
+       | Field can be empty or missing, if this EM itself is not controlled.
+
+```
+
+## Caveats
+
+Nothing - at least not known.
+If you found something, please contact us!

docs/readthedocs/models/input/participant/ev.md

@@ -93,6 +93,12 @@ Model of an electric vehicle, that is occasionally connected to the grid via an
      - --
      - 
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ## Caveats

docs/readthedocs/models/input/participant/evcs.md

@@ -59,6 +59,12 @@ station and has some limitations outlined below.
      - --
      - 	:ref:`Charging station location types<location-types>` 
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ### Type Model

docs/readthedocs/models/input/participant/fixedfeedin.md

@@ -49,6 +49,12 @@ model can be derived.
      - --
      - Rated power factor
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ## Caveats

docs/readthedocs/models/input/participant/hp.md

@@ -93,6 +93,12 @@ Model of a heat pump.
      - --
      -
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 
 ```
 

docs/readthedocs/models/input/participant/load.md

@@ -60,6 +60,12 @@ Model of (mainly) domestic loads.
      - --
      - Rated power factor
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ## Caveats

docs/readthedocs/models/input/participant/pv.md

@@ -76,6 +76,12 @@ Detailed model of a photovoltaic power plant.
      - --
      - Rated power factor
 
+   * - em
+     - --
+     - | UUID reference to an :ref:`Energy Management Unit<em_model>` that is controlling
+       | this system participant. Field can be empty or missing, if this participant
+       | is not controlled.
+
 ```
 
 ## Caveats