From 82acc8775b0d0e01fc920847f38a9f50f2c30f92 Mon Sep 17 00:00:00 2001 From: t-ober <63147366+t-ober@users.noreply.github.com> Date: Mon, 7 Jun 2021 09:41:39 +0200 Subject: [PATCH 1/3] adjust javadocs documentation --- .../models/input/connector/ConnectorInput.java | 6 ++++-- .../datamodel/models/input/connector/LineInput.java | 6 ++++-- .../models/input/connector/Transformer2WInput.java | 6 ++++-- .../models/input/connector/Transformer3WInput.java | 12 ++++++++---- .../models/input/connector/TransformerInput.java | 6 ++++-- 5 files changed, 24 insertions(+), 12 deletions(-) diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java index b7536e7d4..528a9c91c 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java @@ -30,7 +30,8 @@ public abstract class ConnectorInput extends AssetInput implements HasNodes { * @param operationTime Time for which the entity is operated * @param nodeA Grid node at one side of the connector * @param nodeB Grid node at the other side of the connector - * @param parallelDevices Amount of parallel devices + * @param parallelDevices overall amount of parallel devices to automatically construct (e.g. + * parallelDevices = 2 will build a total of two entities using the specified parameters) */ public ConnectorInput( UUID uuid, @@ -53,7 +54,8 @@ public ConnectorInput( * @param id of the asset * @param nodeA Grid node at one side of the connector * @param nodeB Grid node at the other side of the connector - * @param parallelDevices Amount of parallel devices + * @param parallelDevices overall amount of parallel devices to automatically construct (e.g. + * parallelDevices = 2 will build a total of two entities using the specified parameters) */ public ConnectorInput( UUID uuid, String id, NodeInput nodeA, NodeInput nodeB, int parallelDevices) { diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java index 72502cc97..a4b231e9e 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java @@ -43,7 +43,8 @@ public class LineInput extends ConnectorInput implements HasType { * @param operationTime Time for which the entity is operated * @param nodeA Grid node at one side of the line * @param nodeB Grid node at the other side of the line - * @param parallelDevices Amount of parallel lines + * @param parallelDevices overall amount of parallel lines to automatically construct (e.g. + * parallelDevices = 2 will build a total of two lines using the specified parameters) * @param type of line * @param length of this line * @param geoPosition Coordinates of this line @@ -75,7 +76,8 @@ public LineInput( * @param id of the asset * @param nodeA Grid node at one side of the line * @param nodeB Grid node at the other side of the line - * @param parallelDevices Amount of parallel lines + * @param parallelDevices overall amount of parallel lines to automatically construct (e.g. + * parallelDevices = 2 will build a total of two lines using the specified parameters) * @param type of line * @param length of this line * @param geoPosition Coordinates of this line diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java index 22b0b8f8e..725e70046 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java @@ -30,7 +30,8 @@ public class Transformer2WInput extends TransformerInput implements HasType { * @param operationTime Time for which the entity is operated * @param nodeA higher voltage node * @param nodeB lower voltage node - * @param parallelDevices Amount of singular transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param type of 2W transformer * @param tapPos Tap position of this transformer * @param autoTap True, if the tap position of the transformer is adapted automatically @@ -57,7 +58,8 @@ public Transformer2WInput( * @param id of the asset * @param nodeA higher voltage node * @param nodeB lower voltage node - * @param parallelDevices Amount of singular transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param type of 2W transformer * @param tapPos Tap position of this transformer * @param autoTap True, if the tap position of the transformer is adapted automatically diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java index 25861b63c..760972f40 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java @@ -37,7 +37,8 @@ public class Transformer3WInput extends TransformerInput implements HasType { * @param nodeA The higher voltage node * @param nodeB The middle voltage node * @param nodeC The lower voltage node - * @param parallelDevices Amount of singular transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param type of 3W transformer * @param tapPos Tap Position of this transformer * @param autoTap true, if there is an automated regulation activated for this transformer @@ -85,7 +86,8 @@ public Transformer3WInput( * @param nodeA The higher voltage node * @param nodeB The middle voltage node * @param nodeC The lower voltage node - * @param parallelDevices Amount of singular transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param type of 3W transformer * @param tapPos Tap Position of this transformer * @param autoTap true, if there is an automated regulation activated for this transformer @@ -136,7 +138,8 @@ public Transformer3WInput( * @param nodeA The higher voltage node * @param nodeB The middle voltage node * @param nodeC The lower voltage node - * @param parallelDevices Amount of singular transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param type of 3W transformer * @param tapPos Tap Position of this transformer * @param autoTap true, if there is an automated regulation activated for this transformer @@ -177,7 +180,8 @@ public Transformer3WInput( * @param nodeA The higher voltage node * @param nodeB The middle voltage node * @param nodeC The lower voltage node - * @param parallelDevices Amount of singular transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param type of 3W transformer * @param tapPos Tap Position of this transformer * @param autoTap true, if there is an automated regulation activated for this transformer diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java index bef9330ad..b5c10cb00 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java @@ -27,7 +27,8 @@ public abstract class TransformerInput extends ConnectorInput { * @param id of the asset * @param nodeA Grid node at the high voltage winding * @param nodeB Grid node at the low voltage winding - * @param parallelDevices Amount of parallel transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param tapPos Tap Position of this transformer * @param autoTap True, if the tap position of the transformer is adapted automatically */ @@ -53,7 +54,8 @@ public TransformerInput( * @param id of the asset * @param nodeA Grid node at the high voltage winding * @param nodeB Grid node at the low voltage winding - * @param parallelDevices Amount of parallel transformers + * @param parallelDevices overall amount of parallel transformers to automatically construct (e.g. + * parallelDevices = 2 will build a total of two transformers using the specified parameters) * @param tapPos Tap Position of this transformer * @param autoTap True, if the tap position of the transformer is adapted automatically */ From 6951ce71ce5d4501eea11dd102d78dd38898c6b7 Mon Sep 17 00:00:00 2001 From: t-ober <63147366+t-ober@users.noreply.github.com> Date: Mon, 7 Jun 2021 09:42:10 +0200 Subject: [PATCH 2/3] adjust readthedocs documentation --- docs/readthedocs/models/input/grid/line.rst | 4 +- .../models/input/grid/transformer2w.rst | 48 +++++++++-------- .../models/input/grid/transformer3w.rst | 52 ++++++++++--------- 3 files changed, 55 insertions(+), 49 deletions(-) diff --git a/docs/readthedocs/models/input/grid/line.rst b/docs/readthedocs/models/input/grid/line.rst index 5f489504d..800cb3092 100644 --- a/docs/readthedocs/models/input/grid/line.rst +++ b/docs/readthedocs/models/input/grid/line.rst @@ -48,7 +48,9 @@ Entity Model +-------------------+------+--------------------------------------------------------+ | nodeB | -- | | +-------------------+------+--------------------------------------------------------+ -| parallelDevices | -- | Amount of parallel devices of same attributes | +| parallelDevices | -- | | overall amount of parallel lines to automatically | +| | -- | | construct (e.g. parallelDevices = 2 will build a | +| | -- | | total of two lines using the specified parameters) | +-------------------+------+--------------------------------------------------------+ | type | -- | | +-------------------+------+--------------------------------------------------------+ diff --git a/docs/readthedocs/models/input/grid/transformer2w.rst b/docs/readthedocs/models/input/grid/transformer2w.rst index 248a22fc1..f9c89f1b7 100644 --- a/docs/readthedocs/models/input/grid/transformer2w.rst +++ b/docs/readthedocs/models/input/grid/transformer2w.rst @@ -50,29 +50,31 @@ As obvious, the parameter can be used in T- as in 𝜋-equivalent circuit repres Entity Model """""""""""" -+-----------------+------+--------------------------------------------------------+ -| Attribute | Unit | Remarks | -+=================+======+========================================================+ -| uuid | -- | | -+-----------------+------+--------------------------------------------------------+ -| id | -- | Human readable identifier | -+-----------------+------+--------------------------------------------------------+ -| operator | -- | | -+-----------------+------+--------------------------------------------------------+ -| operationTime | -- | Timely restriction of operation | -+-----------------+------+--------------------------------------------------------+ -| nodeA | -- | Higher voltage node | -+-----------------+------+--------------------------------------------------------+ -| nodeB | -- | Lower voltage node | -+-----------------+------+--------------------------------------------------------+ -| parallelDevices | -- | Amount of parallel devices of same attributes | -+-----------------+------+--------------------------------------------------------+ -| type | -- | | -+-----------------+------+--------------------------------------------------------+ -| tapPos | -- | Current position of the tap changer | -+-----------------+------+--------------------------------------------------------+ -| autoTap | -- | true, if there is a tap regulation apparent and active | -+-----------------+------+--------------------------------------------------------+ ++-----------------+------+------------------------------------------------------------+ +| Attribute | Unit | Remarks | ++=================+======+============================================================+ +| uuid | -- | | ++-----------------+------+------------------------------------------------------------+ +| id | -- | Human readable identifier | ++-----------------+------+------------------------------------------------------------+ +| operator | -- | | ++-----------------+------+------------------------------------------------------------+ +| operationTime | -- | Timely restriction of operation | ++-----------------+------+------------------------------------------------------------+ +| nodeA | -- | Higher voltage node | ++-----------------+------+------------------------------------------------------------+ +| nodeB | -- | Lower voltage node | ++-----------------+------+------------------------------------------------------------+ +| parallelDevices | -- | | overall amount of parallel transformers to automatically | +| | -- | | construct (e.g. parallelDevices = 2 will build a | +| | -- | | total of two transformers using the specified parameters)| ++-----------------+------+------------------------------------------------------------+ +| type | -- | | ++-----------------+------+------------------------------------------------------------+ +| tapPos | -- | Current position of the tap changer | ++-----------------+------+------------------------------------------------------------+ +| autoTap | -- | true, if there is a tap regulation apparent and active | ++-----------------+------+------------------------------------------------------------+ Caveats ^^^^^^^ diff --git a/docs/readthedocs/models/input/grid/transformer3w.rst b/docs/readthedocs/models/input/grid/transformer3w.rst index fd60cd942..db4e67d00 100644 --- a/docs/readthedocs/models/input/grid/transformer3w.rst +++ b/docs/readthedocs/models/input/grid/transformer3w.rst @@ -70,31 +70,33 @@ All impedances and admittances are given with respect to the higher voltage side Entity Model """""""""""" -+-----------------+------+--------------------------------------------------------+ -| Attribute | Unit | Remarks | -+=================+======+========================================================+ -| uuid | -- | | -+-----------------+------+--------------------------------------------------------+ -| id | -- | Human readable identifier | -+-----------------+------+--------------------------------------------------------+ -| operator | -- | | -+-----------------+------+--------------------------------------------------------+ -| operationTime | -- | Timely restriction of operation | -+-----------------+------+--------------------------------------------------------+ -| nodeA | -- | Higher voltage node | -+-----------------+------+--------------------------------------------------------+ -| nodeB | -- | Intermediate voltage node | -+-----------------+------+--------------------------------------------------------+ -| nodeC | -- | Lowest voltage node | -+-----------------+------+--------------------------------------------------------+ -| parallelDevices | -- | Amount of parallel devices of same attributes | -+-----------------+------+--------------------------------------------------------+ -| type | -- | | -+-----------------+------+--------------------------------------------------------+ -| tapPos | -- | Current position of the tap changer | -+-----------------+------+--------------------------------------------------------+ -| autoTap | -- | true, if there is a tap regulation apparent and active | -+-----------------+------+--------------------------------------------------------+ ++-----------------+------+------------------------------------------------------------+ +| Attribute | Unit | Remarks | ++=================+======+============================================================+ +| uuid | -- | | ++-----------------+------+------------------------------------------------------------+ +| id | -- | Human readable identifier | ++-----------------+------+------------------------------------------------------------+ +| operator | -- | | ++-----------------+------+------------------------------------------------------------+ +| operationTime | -- | Timely restriction of operation | ++-----------------+------+------------------------------------------------------------+ +| nodeA | -- | Higher voltage node | ++-----------------+------+------------------------------------------------------------+ +| nodeB | -- | Intermediate voltage node | ++-----------------+------+------------------------------------------------------------+ +| nodeC | -- | Lowest voltage node | ++-----------------+------+------------------------------------------------------------+ +| parallelDevices | -- | | overall amount of parallel transformers to automatically | +| | -- | | construct (e.g. parallelDevices = 2 will build a | +| | -- | | total of two transformers using the specified parameters)| ++-----------------+------+------------------------------------------------------------+ +| type | -- | | ++-----------------+------+------------------------------------------------------------+ +| tapPos | -- | Current position of the tap changer | ++-----------------+------+------------------------------------------------------------+ +| autoTap | -- | true, if there is a tap regulation apparent and active | ++-----------------+------+------------------------------------------------------------+ Caveats ^^^^^^^ From 644428e635fe28499f155c0aafcdb86aa6a016a4 Mon Sep 17 00:00:00 2001 From: t-ober <63147366+t-ober@users.noreply.github.com> Date: Mon, 7 Jun 2021 10:24:12 +0200 Subject: [PATCH 3/3] update stable release version --- docs/readthedocs/gettingstarted.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/gettingstarted.rst b/docs/readthedocs/gettingstarted.rst index 768aa8800..e1ccfcfdb 100644 --- a/docs/readthedocs/gettingstarted.rst +++ b/docs/readthedocs/gettingstarted.rst @@ -25,7 +25,7 @@ On `Maven central com.github.ie3-institute PowerSystemDataModel - 1.1.0 + 2.0.0 Snapshot releases