e2nIEE · panos-xenos · Oct 9, 2024 · Oct 30, 2024 · Nov 14, 2024 · Nov 15, 2024
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -9,6 +9,26 @@ Change Log
 - [FIXED] Allow to consider all oos components in nx graph creation
 - [REMOVED] Excluding tests and test_files from built packages
 - [ADDED] Static Var Compensator with Voltage Control
+- [CHANGED] updated PowerFactory to pandapower converter to export measurement reports and reflect changes in trafo/trafo3w tap changer logic
+- [ADDED] shunt_characteristic_spline table
+- [CHANGED] renamed characteristic table to trafo_characteristic_spline table and changed its structure so that there is one row with all spline characteristic objects per trafo/trafo3w
+- [ADDED] step_dependency_table flag for shunt elements
+- [CHANGED] renamed tap_dependent_impedance flag to tap_dependency_table for trafo and trafo3w elements
+- [ADDED] id_characteristic_spline optional variable for shunt elements
+- [REMOVED] vk_hv_percent_characteristic, vk_mv_percent_characteristic, vk_lv_percent_characteristic, vkr_hv_percent_characteristic, vkr_mv_percent_characteristic and vkr_lv_percent_characteristic variables from trafo3w table
+- [REMOVED] vk_percent_characteristic and vkr_percent_characteristic variables from trafo table
+- [ADDED] id_characteristic_spline optional variable for trafo and trafo3w elements
+- [ADDED] id_characteristic_table variable for shunt elements
+- [CHANGED] renamed id_characteristic variable to id_characteristic_table for trafo and trafo3w elements
+- [ADDED] shunt_characteristic_table lookup table for step dependent values for shunt elements
+- [CHANGED] renamed characteristic_temp lookup table to trafo_characteristic_table for trafo and trafo3w elements
+- [CHANGED] cim2pp converter - removed default creation of trafo spline characteristics
+- [ADDED] cim2pp converter - export NonlinearShuntCompensatorPoint values for shunt elements
+- [FIXED] cim2pp converter - correctly populate step, max_step and q_mvar / p_mw values per step for shunt elements
+- [ADDED] cim2pp converter - added tap changer type classification for trafo and trafo3w elements
+- [FIXED] cim2pp converter - correctly populate tap_step_degree and shift_degree variables for trafo and trafo3w elements
+- [ADDED] tap_changer_type variable for net.trafo and net.trafo3w tables (supporting "Ratio", "Symmetrical", "Ideal" and "Tabular" tap changer types)
+- [REMOVED] tap_phase_shifter bool variable from net.trafo table
 - [ADDED] Implementation of Allocation Factor WLS (AF-WLS) for non observable distribution grids
 - [FIXED] Deletion of multiple measurements at the same bus or branch
 - [FIXED] Creation of zero injection measurements in WLS estimator
@@ -33,6 +53,7 @@ Change Log
 - [FIXED] default elements in toolbox function add_zones_to_elements()
 - [ADDED] improved lightsim2grid documentation including compatibitliy issues
 - [FIXED] avoid duplicated keys in kwargs and pf_options in run_contingency()
+- [ADDED] improved lightsim2grid documentation including compatibility issues
 - [FIXED] cim2pp: set default xml encoding to None to avoid error after changing to lxml
 - [FIXED] PandaModels OPF with 'bus_dc' key errors
 - [FIXED] julia tests
@@ -65,7 +86,7 @@ Change Log
 - [CHANGED] plotting for voltage profile considers also gens that are slacks and only ext_grids and slack gens that are in service
 - [CHANGED] switched from setup.py to pyproject.toml
 - [CHANGED] updated upload_release.py to not call setup.py anymore (see https://packaging.python.org/en/latest/discussions/setup-py-deprecated/)
-- [CHANGED] updated upload_release.py to install the uploadad package and print the version
+- [CHANGED] updated upload_release.py to install the uploaded package and print the version
 - [CHANGED] updated MANIFEST.in to exclude the ci files from the wheel distribution
 - [CHANGED] cim data structure method in cim converter changed to blueprint approach
 - [CHANGED] cim converter: Avoid huge logging output when ignore_errors = True

diff --git a/doc/about/deprecating.rst b/doc/about/deprecating.rst
@@ -13,21 +13,21 @@ This figure illustrates a time sequence of a process with deprecation warnings,
 		:width: 500em
 		:align: center
 
-Proposed steps for contributers and reviewers:
+Proposed steps for contributors and reviewers:
 
 #. Provide two pull requests (PR1 and PR2) including
     #. final code that should remain in the long-term
-        * if input parameter names have been changed, these can be catched and notified using :code:`raise DeprecationWarning("Notification message")`
+        * if input parameter names have been changed, this can be handled and a notification issued using :code:`raise DeprecationWarning("Notification message")`
     #. interim code to be contained in the master branch from the next to the next but one release version
         * to implement deprecation warnings type :code:`warnings.warn("Notification message", category=DeprecationWarning)` (:code:`category=FutureWarning` is also possible; don't forget :code:`import warnings`)
-        * the new functionality should be available but if the user does not pass arguments that explicitely call the new functionality, the old functionality should be evaluated plus sending DeprecationWarnings
+        * the new functionality should be available but if the user does not pass arguments that explicitly call the new functionality, the old functionality should be evaluated plus sending DeprecationWarnings
         * make sure to add new tests for the new functionality
         * please add :code:`assert Version(pp.__version__) < Version('2.12')` with :code:`from packaging.version import Version` to the tests of the deprecated functionality (assuming that the latest pandapower version is `v2.10.x` ; tests of the deprecated code should be removed with PR1)
 #. Reviewer: don't approve the PRs as long as both PRs are correct and complete
 #. The person merging PR2 is responsible to merge PR1 after the next release
 
 As an example, please have a look at the revision of the function `pandapower.toolbox.merge_nets()`.
-It has been revised by `PR2 <https://github.com/e2nIEE/pandapower/pull/1764>`_ temporarly. This state is available from pandapower version `v2.10.0` to `v2.11.1`.
+It has been revised by `PR2 <https://github.com/e2nIEE/pandapower/pull/1764>`_ temporarily. This state is available from pandapower version `v2.10.0` to `v2.11.1`.
 With `v2.12.0` the final code, merged via `PR1 <https://github.com/e2nIEE/pandapower/pull/1765>`_, is available.
 
 For suggestions on revising this process, `Issue 1760 <https://github.com/e2nIEE/pandapower/issues/1760>`_ can be reopened.
diff --git a/doc/about/units.rst b/doc/about/units.rst
@@ -47,7 +47,7 @@ The power equation in the balanced three phase system is therefore given as :mat
 For unbalanced three phase systems, the following conventions apply:
     - voltage values are entered as phase-to-phase voltages
     - current values are entered as phase currents
-    - But, Phase power values can be entered seperately in the new element **asymmetric_load** 
+    - But, Phase power values can be entered separately in the new element **asymmetric_load**
 
 The power equation in each phase is therefore given as :math:`S_{ph-e} = \frac{V_{ph-ph} \cdot I_{ph-ph}}{\sqrt3 }`.
 

diff --git a/doc/about/update20.rst b/doc/about/update20.rst
@@ -181,7 +181,7 @@ the cost parameters can be directly specified as parameters instead of passing a
 | **pandapower 2.x** | :code:`pp.create_poly_cost(net, 3, "gen", c_per_mw=0.1, c2_per_mw2=0.01)`                                    |
 +--------------------+--------------------------------------------------------------------------------------------------------------+
 
-The definition of piecewise linear costs has also changed. In pandapower 1.x, the cost polyonmial is given as list of cost points: ::
+The definition of piecewise linear costs has also changed. In pandapower 1.x, the cost polynomial is given as list of cost points: ::
 
     [(p1, c1), (p2, c2), (p3, c3)]
 

diff --git a/doc/about/update30.rst b/doc/about/update30.rst
@@ -28,7 +28,13 @@ This is established by multiple functions/codings in the pandapower package.
 The columns in :code:`net.group` are also changed: To :code:`element_type` and :code:`element_index` to avoid misunderstandings.
 A major rework could include the names :code:`element_type` and :code:`element_index` at any place in the package but has not been implemented (yet?) since it would break large parts of package usage.
 
+Transformers
+=============
+Different types of tap changers for 2-winding and 3-winding transformers are now explicitly accessible via :code:`tap_changer_type` (string) "Ratio", "Symmetrical" or "Ideal".
+
+
 To sum up, the following changes were made:
 
     - TrafoController parameters: :code:`trafotable, trafotype` ➔ :code:`element_type`; :code:`tid` ➔ :code:`element_index`
     - Group column: :code:`net.groups.element` ➔ :code:`net.groups.element_index`
+    - the tap changer variables :code:`tap_phase_shifter` ➔ :code:`tap_changer_type` bool True/False to string "Ratio","Symmetrical","Ideal".
diff --git a/doc/control/controller.rst b/doc/control/controller.rst
@@ -107,11 +107,10 @@ SplineCharacteristic
 .. autoclass:: pandapower.control.util.characteristic.SplineCharacteristic
     :members:
 
-The following controllers are used for the representation of station controllers as used in PowerFactory
-
 
 Station Controller
 ==================
+The following controllers are used for the representation of station controllers as used in PowerFactory
 
 **********************
 Binary Search Control

diff --git a/doc/converter/ucte.rst b/doc/converter/ucte.rst
@@ -2,7 +2,7 @@
 UCTE-DEF to pandapower
 ===================================================
 
-panpapower functionality allows to convert grid data from **UCTE** **d**ata **e**xchange **f**ormat for load flow and three phase short circuit studies (UCTE-DEF) to pandapower.
+panpapower functionality allows to convert grid data from **UCTE**  data exchange format for load flow and three phase short circuit studies (UCTE-DEF) to pandapower.
 The UCTE-DEF is a simple data format for electric transmission systems for the exchange of grid data introduced by the *Union for the Co-ordination of Transmission of Electricity (UCTE)*, the predecessor of the ENTSO-E.
 
 Using the Converter

diff --git a/doc/elements/asymmetric_load.rst b/doc/elements/asymmetric_load.rst
@@ -34,7 +34,7 @@ Input Parameters
 
 .. note::
 
-    - The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on panadapower. It is not considered in the power flow!
+    - The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on pandapower. It is not considered in the power flow!
 
     - 'wye' is the same as PH-E loads
 

diff --git a/doc/elements/asymmetric_sgen.rst b/doc/elements/asymmetric_sgen.rst
@@ -58,7 +58,7 @@ The PQ-Values are calculated from the parameter table values as:
 
 .. note::
 
-    The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on panadapower. It is not considered in the power flow!
+    The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on pandapower. It is not considered in the power flow!
 
 Result Parameters
 ==========================

diff --git a/doc/elements/ext_grid.rst b/doc/elements/ext_grid.rst
@@ -53,7 +53,7 @@ with:
    \end{align*}
 
 
-** Unbalanced Load Flow / Single phase short ciruit **
+** Unbalanced Load Flow / Single phase short circuit **
 
 The external grid is modelled as a voltage source for positive sequence model, which means the node the grid is connected to is treated as a slack node.
 For zero sequence and negative sequence external grid impedance is calculated:

diff --git a/doc/elements/impedance.rst b/doc/elements/impedance.rst
@@ -48,7 +48,7 @@ The per unit values are therefore transformed into the network per unit system:
 
 where :math:`S_{N}` is the reference power of the per unit system (see :ref:`Unit Systems and Conventions<conventions>`). 
 
-The asymetric impedance results in an asymetric nodal point admittance matrix:
+The asymmetric impedance results in an asymmetric nodal point admittance matrix:
 
 .. math::
    :nowrap:

diff --git a/doc/elements/line.rst b/doc/elements/line.rst
@@ -95,7 +95,7 @@ The power system frequency :math:`f` is defined when creating an empty network,
 
 .. note::
 
-	For three phase load flow, three decoupled sequence networks ( zero , positive and negtive) are considered.
+	For three phase load flow, three decoupled sequence networks ( zero , positive and negative) are considered.
 
 	**Positive and Negative sequence impedances** are given by r_ohm_per_km, x_ohm_per_km, and c_nf_per_km
 

diff --git a/doc/elements/load.rst b/doc/elements/load.rst
@@ -33,7 +33,7 @@ Input Parameters
 
 .. note::
 
-    The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on panadapower. It is not considered in the power flow!  
+    The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on pandapower. It is not considered in the power flow!
 
 
 Electric Model

diff --git a/doc/elements/sgen.rst b/doc/elements/sgen.rst
@@ -59,7 +59,7 @@ The PQ-Values are calculated from the parameter table values as:
 
 .. note::
 
-    The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on panadapower. It is not considered in the power flow!
+    The apparent power value sn_mva is provided as additional information for usage in controller or other applications based on pandapower. It is not considered in the power flow!
 
 Result Parameters
 ==========================

diff --git a/doc/elements/shunt.rst b/doc/elements/shunt.rst
@@ -68,7 +68,45 @@ Converting to the per unit system results in:
    \end{align*}
 
 with the reference values for the per unit system as defined in :ref:`Unit Systems and Conventions<conventions>`.
-
+
+Shunt characteristic table
+============================
+
+A shunt characteristic table (shunt_characteristic_table) can be used to adjust the shunt parameters
+(q_mvar, p_mw) according to the selected step position. This lookup table is created automatically
+from version 3.0 onwards through the CIM CGMES to pandapower converter (if this information is available in the EQ
+profile), or the user may define this table manually. The id_characteristic_table variable in net.shunt references
+the id_characteristic column in net.shunt_characteristic_table per shunt.
+
+If the shunt_dependency_table variable in net.shunt is set to True, this indicates that there is a corresponding
+characteristic available in net.shunt_characteristic_table, which overwrites the default shunt parameters
+q_mvar and p_mw.
+
+The below table provides an example shunt_characteristic_table, populated for two shunt elements.
+
+.. tabularcolumns:: |p{0.10\linewidth}|p{0.55\linewidth}|p{0.15\linewidth}|p{0.20\linewidth}|p{0.20\linewidth}
+.. csv-table::
+   :file: shunt_char_table.csv
+   :delim: ,
+   :widths: 10, 55, 15, 20, 20
+
+.. note::
+    shunt_dependency_table has to be set to True and the id_characteristic_table variable needs to be populated in order to consider the corresponding shunt_characteristic_table values.
+
+The function pandapower.control.shunt_characteristic_table_diagnostic can be used for sanity checks.
+The function pandapower.control.create_shunt_characteristic_object can be used to automatically create
+SplineCharacteristic objects and populate the net.shunt_characteristic_spline table according to the
+net.shunt_characteristic_table table. An additional column id_characteristic_spline is also created in net.shunt
+to set up the reference to the spline characteristics.
+
+The below table provides an example shunt_characteristic_spline table, populated for two shunt elements.
+
+.. tabularcolumns:: |p{0.10\linewidth}|p{0.55\linewidth}|p{0.55\linewidth}|p{0.55\linewidth}
+.. csv-table::
+   :file: shunt_char_spline.csv
+   :delim: ,
+   :widths: 10, 55, 55, 55
+
 Result Parameters
 ==========================
 *net.res_shunt*

diff --git a/doc/elements/shunt_char_spline.csv b/doc/elements/shunt_char_spline.csv
@@ -0,0 +1,3 @@
+,id_characteristic,q_mvar_characteristic,p_mw_characteristic
+0,0,SplineCharacteristic,SplineCharacteristic
+1,1,SplineCharacteristic,SplineCharacteristic
diff --git a/doc/elements/shunt_char_table.csv b/doc/elements/shunt_char_table.csv
@@ -0,0 +1,11 @@
+,id_characteristic,step,q_mvar,p_mw
+0,0,1,176.3999987,0.223000955
+1,0,2,171.0046573,0.223000955
+2,0,3,165.6093266,0.223000955
+3,0,4,160.2139746,0.223000955
+4,0,5,155.4759927,0.223000955
+5,1,1,179.999968,0.034992
+6,1,2,174.083296,0.034992
+7,1,3,168.166624,0.034992
+8,1,4,162.249952,0.034992
+9,1,5,156.333296,0.034992
diff --git a/doc/elements/shunt_par.csv b/doc/elements/shunt_par.csv
@@ -1,8 +1,11 @@
 **Parameter**;**Datatype**;**Value Range**;**Explanation**
 name;string;;name of the shunt
 bus*;integer;;index of bus where the impedance starts
-p_mw*;float;:math:`\geq` 0;shunt active power in MW at v= 1.0 p.u.
-q_mvar*;float;;shunt reactive power in kvar at v= 1.0 p.u.
+p_mw*;float;:math:`\geq` 0;shunt active power in MW at v= 1.0 p.u. per step
+q_mvar*;float;;shunt reactive power in MVAr at v= 1.0 p.u. per step
 vn_kv*;float;:math:`>` 0;rated voltage of the shunt element
-step*;integer;:math:`\geq` 1;step position of the shunt
-in_service*;boolean;True / False;specifies if the shunt is in service.
+step*;integer;:math:`\geq` 1;step position of the shunt with which power values are multiplied
+max_step*;integer;:math:`\geq` 1;maximum allowed step of shunt
+in_service*;boolean;True / False;specifies if the shunt is in service
+step_dependency_table;boolean;True / False;whether the shunt parameters (q_mvar, p_mw) are adjusted dependent on the step of the shunt
+id_characteristic_table;integer;:math:`\geq` 0;references the id_characteristic index from the shunt_characteristic_table
diff --git a/doc/elements/storage.rst b/doc/elements/storage.rst
@@ -54,7 +54,7 @@ The PQ-Values are calculated from the parameter table values as:
 
 .. note::
 
-    The apparent power value sn_mva, state of charge soc and storage capacity max_e_mwh are provided as additional information for usage in controller or other applications based on panadapower. It is not considered in the power flow!
+    The apparent power value sn_mva, state of charge soc and storage capacity max_e_mwh are provided as additional information for usage in controller or other applications based on pandapower. It is not considered in the power flow!
 
 Result Parameters
 ==========================

diff --git a/doc/elements/switch.rst b/doc/elements/switch.rst
@@ -43,7 +43,7 @@ This has the following advantages compared to modelling the switch as a small im
 
 *Bus-Element-Switches:*
 
-When the power flow is calculated internally for every open bus-element switch an auxilary bus is created in the pypower case file. The pypower branch that corresponds to the element is then connected to this bus. This has the following advantages compared to modelling the switch by setting the element out of service:
+When the power flow is calculated internally for every open bus-element switch an auxiliary bus is created in the pypower case file. The pypower branch that corresponds to the element is then connected to this bus. This has the following advantages compared to modelling the switch by setting the element out of service:
 
     - loading current is considered
     - information about switch position is preserved

diff --git a/doc/elements/tcsc.rst b/doc/elements/tcsc.rst
@@ -9,7 +9,7 @@ We implement the FACTS devices based on the following source:
     A. Panosyan, "Modeling of advanced power transmission system controllers",
     Ph.D. dissertation, Gottfried Wilhelm Leibniz Universität Hannover, 2010.
 
-Thyristor-Controlled Series Capacitor (TCSC) device is a series element that controles the power flowing through its
+Thyristor-Controlled Series Capacitor (TCSC) device is a series element that controls the power flowing through its
 path by regulating its impedance.
 The TCSC device is very similar to the Static Var Compensator (SVC) - in fact, it is its series counterpart.
 Indeed, a TCSC device consists of a parallel circuit of a fixed capacitor and a reactor controlled by a pair of