diff --git a/README.rst b/README.rst index ed80140..67dff90 100644 --- a/README.rst +++ b/README.rst @@ -77,7 +77,7 @@ The ESA team works hard to ensure ESA is well tested, and we strive for testing coverage data for ESA, using `coverage `__. -.. table:: ESA's testing coverage as of 2022-08-22 (Git commit: 4b28569) +.. table:: ESA's testing coverage as of 2022-09-15 (Git commit: 09a0fb7) :widths: auto :align: left @@ -86,7 +86,7 @@ testing coverage data for ESA, using `coverage +=================+===================+=================+=================+====================+ | esa/__init__.py | 2 | 0 | 2 | 100 | +-----------------+-------------------+-----------------+-----------------+--------------------+ - | esa/saw.py | 920 | 0 | 920 | 100 | + | esa/saw.py | 1124 | 0 | 1124 | 100 | +-----------------+-------------------+-----------------+-----------------+--------------------+ License diff --git a/VERSION b/VERSION index 5975b14..434dcac 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.2.8 \ No newline at end of file +1.2.9 \ No newline at end of file diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle index 9e24510..c1cbd28 100644 --- a/docs/doctrees/environment.pickle +++ b/docs/doctrees/environment.pickle @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:eaf6fc46551bf1b081a2f736c4f5e03bfbe577659bf6fec2bf77193995804e77 -size 75337 +oid sha256:4e29ac7436c46c295f280ef7e85d84bddc94cc4441de249647e8cf5f8d4749a2 +size 76583 diff --git a/docs/doctrees/esa.doctree b/docs/doctrees/esa.doctree index 0d75635..cd6f5e0 100644 --- a/docs/doctrees/esa.doctree +++ b/docs/doctrees/esa.doctree @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d6da394dedf5a6a75c0b15139331128e705d13651e30a99df2fa2435d739220c -size 408900 +oid sha256:5bb4928057a36445e0c3b517b5224764ac582d263eeb20a2d1b7d44c6f4e6f02 +size 422281 diff --git a/docs/doctrees/overview.doctree b/docs/doctrees/overview.doctree index c870be5..bb3d81c 100644 --- a/docs/doctrees/overview.doctree +++ b/docs/doctrees/overview.doctree @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:692841cd89f9063b19f2b12c247a55c65dc8de5c0e9d90827d00732cddfb16d9 -size 30599 +oid sha256:8b60c51408adf626a0a2f7c50a57334ec166d7f99057fb7fa17fd8b578108af2 +size 30603 diff --git a/docs/doctrees/welcome.doctree b/docs/doctrees/welcome.doctree index 282befc..ada5c75 100644 --- a/docs/doctrees/welcome.doctree +++ b/docs/doctrees/welcome.doctree @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:999a9e9e885543ff76280fd6035e25917ba6c5e97d9fd179269a0256bcefb9ff -size 99108 +oid sha256:326f14e6606ad732909f25abcfd851cac003341a1f3ee7a792c39f12d1116707 +size 100937 diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo index 8f58ddc..9387794 100644 --- a/docs/html/.buildinfo +++ b/docs/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: a53f9ecfe3e60fd7052d70b826a9f37e +config: e0464f6a5f354efa64833053541a243d tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js index b84442d..874d066 100644 --- a/docs/html/_static/documentation_options.js +++ b/docs/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.2.8', + VERSION: '1.2.9', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/html/esa.html b/docs/html/esa.html index fc12351..7c26835 100644 --- a/docs/html/esa.html +++ b/docs/html/esa.html @@ -1396,6 +1396,24 @@

Clean up for the PowerWorld COM object

+
+
+fast_n1_test()
+

A pure LODF-based fast N-1 contingency analysis implementation.

+
+
Returns
+

A boolean value to indicate whether the system is N-1 secure.

+
+
+
+ +
+
+fast_n2_islanding_detection()
+

Quickly identify the N-2 islanding CTGs using LODF

+

returns: A tuple with the number of islanding CTGs and the islanding matrix

+
+
get_branch_admittance()
@@ -1533,10 +1551,10 @@ script CalculateShiftFactorsMultipleElement.

Parameters
-

method – The linear method to be used for the calculation. The

+

method – The linear method to be used for the calculation. The options are AC,

-

options are AC, DC or DCPS. +

DC or DCPS. :returns: A dense float matrix in the numpy array format.

@@ -1695,6 +1713,54 @@ +
+
+run_ecological_analysis(target: str = 'MW', split_generator: bool = True)
+

This method is leveraging applied ecological network analysis to quantify +the varity of robustness of the power system.

+

Reference: +[1] H. Huang, Z. Mao, A. Layton and K. R. Davis, +“An Ecological Robustness Oriented Optimal Power Flow for Power Systems’ Survivability,” +in IEEE Transactions on Power Systems, doi: 10.1109/TPWRS.2022.3168226. +[2] Panyam, V., Huang, H., Davis, K., & Layton, A. (2019). +An ecosystem perspective for the design of sustainable power systems. Procedia Cirp, 80, 269-274.

+
+
Parameters
+

target – the real, reactive, and apparent power over the system. The default value

+
+
+

is MW, which is the real power. Users can change to MVR, which is the reactive power; or +MVA, which is the apparent power. +:param split_generator: Choose to split or aggregate multiple generators associated with +the same bus. If true, the method will consider the generators’ robustness for each +generator.

+
+
Results
+

it is a list of ecological metrics, including the Ecological Robustness (Reco),

+
+
+

the Ascendancy (ASC), the Development Capacity (DC), the Cycled Throughflow (tstc), the Finn Cycling Index (CI) +and the Total System Overhead (TSO)

+
+ +
+
+run_robustness_analysis()
+

Compute the metric RCF to quantify the robustness of +power grids against cascading failures. The RCF metric takes the +operational states, the branch’s capacities and the topological +structure into account and gives an entropy-based value. +The formula is given from the following paper: +Koç, Yakup, Martijn Warnier, Robert E. Kooij, and Frances MT Brazier. +“An entropy-based metric to quantify the robustness of power grids +against cascading failures.” Safety science 59 (2013): 126-134.

+
+
Returns
+

The RCF value.

+
+
+
+
set_simauto_property(property_name: str, property_value: Union[str, bool])
diff --git a/docs/html/genindex.html b/docs/html/genindex.html index 7fe3f8f..89ea7ba 100644 --- a/docs/html/genindex.html +++ b/docs/html/genindex.html @@ -295,10 +295,14 @@

E

F