e2nIEE · rbolgaryn · Oct 5, 2023 · Nov 11, 2022 · Nov 13, 2022 · Nov 16, 2022
diff --git a/.github/workflows/github_test_action.yml b/.github/workflows/github_test_action.yml
@@ -182,10 +182,11 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install pytest nbmake pytest-xdist igraph numba seaborn
           ./.install_julia.sh 1.8
-          pip install julia
+          python -m pip install julia
           python ./.install_pycall.py
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          pip install .["all"]
+          python -m pip install .["all"]
+          python -m pip install lightsim2grid
       - name: List all installed packages
         run: |
           pip list

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -113,6 +113,7 @@ Change Log
 - [CHANGED] Compatibility with pandas 1.5, dropped "six" dependency
 - [CHANGED] from_ppc(): revision of indexing and naming of elements
 - [CHANGED] Complete revision of validate_from_ppc()
+- [ADDED] helper functions for contingency calculation
 - [CHANGED] Improve defaults, add docstrings and rename parameters of plot_voltage_profile() and plot_loading()
 - [CHANGED] merge_nets(): revised for groups and new behavior regarding indexing; reindex_elements(): revised for groups, don't overwrite column "index" and feature parameter lookup
 - [FIXED] Bug with user_pf_options: _init_runpp_options in auxiliary.py ignored user_pf_options when performing sanity checks

diff --git a/doc/contingency.rst b/doc/contingency.rst
@@ -0,0 +1,17 @@
+#####################
+Contingency analysis
+#####################
+
+We can define N-1 cases to be analysed as contingencies. This means that indices of net.line, net.trafo, net.trafo3w can be defined as contingencies, which are switched off one at a time. The power system is analyzed with power flow calculations, and the min/max values among all the N-1 cases are obtained for relevant variables.
+
+A tutorial that introduces this feature with an example is available at `Contingency analysis <https://github.com/e2nIEE/pandapower/tree/develop/tutorials/contingency_analysis.ipynb>`_
+
+.. autofunction:: pandapower.contingency.run_contingency
+
+.. autofunction:: pandapower.contingency.run_contingency_ls2g
+
+.. autofunction:: pandapower.contingency.get_element_limits
+
+.. autofunction:: pandapower.contingency.check_elements_within_limits
+
+.. autofunction:: pandapower.contingency.report_contingency_results
diff --git a/doc/index.rst b/doc/index.rst
@@ -46,6 +46,7 @@ Operation at the Fraunhofer Institute for Energy Economics and Energy System Tec
     elements
     std_types
     powerflow
+    contingency
     opf
     shortcircuit
     estimation

diff --git a/pandapower/contingency/__init__.py b/pandapower/contingency/__init__.py
@@ -0,0 +1 @@
+from pandapower.contingency.contingency import *
diff --git a/pandapower/contingency/contingency.py b/pandapower/contingency/contingency.py
diff --git a/pandapower/test/contingency/test_contingency.py b/pandapower/test/contingency/test_contingency.py
diff --git a/tutorials/contingency_analysis.ipynb b/tutorials/contingency_analysis.ipynb