From 3f367278fabb422801a8462e8a069ffaf5ee6252 Mon Sep 17 00:00:00 2001
From: Zeyu Mao
Date: Wed, 12 Oct 2022 16:26:42 -0500
Subject: [PATCH] 1. Update the setup file
---
docs/doctrees/environment.pickle | 3 +
docs/doctrees/esa.doctree | 4 +-
docs/doctrees/overview.doctree | 2 +-
docs/doctrees/snippets.doctree | 4 +-
docs/doctrees/welcome.doctree | 4 +-
docs/html/.buildinfo | 2 +-
docs/html/_static/documentation_options.js | 2 +-
docs/html/esa.html | 196 +++++++++---------
docs/html/objects.inv | Bin 1446 -> 1446 bytes
docs/html/overview.html | 6 +-
docs/html/searchindex.js | 2 +-
docs/html/snippets.html | 2 +-
docs/html/welcome.html | 6 +
.../snippets/pw_contingency_analysis_2000.rst | 3 +-
esa/__about__.py | 2 +-
setup.py | 14 ++
16 files changed, 138 insertions(+), 114 deletions(-)
create mode 100644 docs/doctrees/environment.pickle
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
new file mode 100644
index 0000000..301b8a1
--- /dev/null
+++ b/docs/doctrees/environment.pickle
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1f39a1d98608144cfb8630b2afea6a148deec844ffb5f697ea2180ac4254dff5
+size 124067
diff --git a/docs/doctrees/esa.doctree b/docs/doctrees/esa.doctree
index d1903a8..abe9357 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:3572cc3ef4345d62e15d3353f071b74c25333e5955fa964e1b124c37b03d8174
-size 483080
+oid sha256:082986449c0f64f156b35419ea0aa187d2f6cf081fdcb9bfb85db3755d40b20b
+size 480501
diff --git a/docs/doctrees/overview.doctree b/docs/doctrees/overview.doctree
index ac101fb..244618f 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:7e42475521f0e8f7de7079ae839fccd775897a33be20a9f2f47c39cbd4937960
+oid sha256:4ed7821c66ecb1e170e1474f00f420039ef671b7e4f0163e8edf9a7a77a70e2a
size 30665
diff --git a/docs/doctrees/snippets.doctree b/docs/doctrees/snippets.doctree
index 2259185..412b2c8 100644
--- a/docs/doctrees/snippets.doctree
+++ b/docs/doctrees/snippets.doctree
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:310ced37c7909afeeeda317f12f16bf38cc95d2d6e24c99240a6a0832ecb944f
-size 98562
+oid sha256:9df16c5ed1481070d5daf396233bd0840e292c0ca0902d710441e3cdbeac4ed9
+size 98236
diff --git a/docs/doctrees/welcome.doctree b/docs/doctrees/welcome.doctree
index 78bf3e3..bcf3889 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:83d5dbae9c65b0bc81090311f4cb57a35ae88d3cfe0ed24a6cac514f25b5fa8f
-size 106474
+oid sha256:839637dc427fd3589383810772b84e8ae58edd9819bc70b2e6e785bd1748cf95
+size 107412
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
index f781c58..0309b49 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: 4f06ae4ed648b0cdfbe03160978092d7
+config: e15d26700d04c6a0e5beedc559d9479f
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js
index 69e84c9..69eeb02 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.3.2',
+ VERSION: '1.3.3',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/docs/html/esa.html b/docs/html/esa.html
index 2efcbee..fbca4f3 100644
--- a/docs/html/esa.html
+++ b/docs/html/esa.html
@@ -244,7 +244,7 @@
here
-
-class esa.saw.SAW(FileName, early_bind=False, UIVisible=False, object_field_lookup=('bus', 'gen', 'load', 'shunt', 'branch'), CreateIfNotFound=False, pw_order=False)[source]
+class esa.saw.SAW(FileName, early_bind=False, UIVisible=False, object_field_lookup=('bus', 'gen', 'load', 'shunt', 'branch'), CreateIfNotFound=False, pw_order=False)[source]
Bases: object
A SimAuto Wrapper in Python
Initialize SimAuto wrapper. The case will be opened, and
@@ -313,7 +313,7 @@
-
-change_and_confirm_params_multiple_element(ObjectType: str, command_df: DataFrame) → None[source]
+change_and_confirm_params_multiple_element(ObjectType: str, command_df: DataFrame) → None[source]
Change parameters for multiple objects of the same type, and
confirm that the change was respected by PowerWorld.
@@ -347,7 +347,7 @@
-
-change_parameters_multiple_element_df(ObjectType: str, command_df: DataFrame) → None[source]
+change_parameters_multiple_element_df(ObjectType: str, command_df: DataFrame) → None[source]
Helper to call ChangeParametersMultipleElement, but uses a
DataFrame to determine parameters and values. This method is
lighter weight but perhaps “riskier” than the
@@ -374,7 +374,7 @@
-
-clean_df_or_series(obj: Union[DataFrame, Series], ObjectType: str) → Union[DataFrame, Series][source]
+clean_df_or_series(obj: Union[DataFrame, Series], ObjectType: str) → Union[DataFrame, Series][source]
Helper to cast data to the correct types, clean up strings,
and sort DataFrame by BusNum (if applicable/present).
@@ -407,13 +407,13 @@
-
-exit()[source]
+exit()[source]
Clean up for the PowerWorld COM object
-
-get_key_fields_for_object_type(ObjectType: str) → DataFrame[source]
+get_key_fields_for_object_type(ObjectType: str) → DataFrame[source]
Helper function to get all key fields for an object type.
- Parameters
@@ -434,7 +434,7 @@
-
-get_key_field_list(ObjectType: str) → List[str][source]
+get_key_field_list(ObjectType: str) → List[str][source]
Convenience function to get a list of key fields for a given
object type.
@@ -451,7 +451,7 @@
-
-get_power_flow_results(ObjectType: str, additional_fields: Union[None, List[str]] = None) → Union[None, DataFrame][source]
+get_power_flow_results(ObjectType: str, additional_fields: Union[None, List[str]] = None) → Union[None, DataFrame][source]
Get the power flow results from SimAuto server.
- Parameters
@@ -475,12 +475,12 @@
-
-get_version_and_builddate() → tuple[source]
+get_version_and_builddate() → tuple[source]
-
-identify_numeric_fields(ObjectType: str, fields: Union[List, ndarray]) → ndarray[source]
+identify_numeric_fields(ObjectType: str, fields: Union[List, ndarray]) → ndarray[source]
Helper which looks up PowerWorld internal field names to
determine if they’re numeric (True) or not (False).
@@ -503,7 +503,7 @@
-
-set_simauto_property(property_name: str, property_value: Union[str, bool])[source]
+set_simauto_property(property_name: str, property_value: Union[str, bool])[source]
Set a SimAuto property, e.g. CreateIfNotFound. The currently
supported properties are listed in the SAW.SIMAUTO_PROPERTIES
class constant.
@@ -521,7 +521,7 @@
-
-get_ybus(full: bool = False, file: Optional[str] = None) → Union[ndarray, csr_matrix][source]
+get_ybus(full: bool = False, file: Optional[str] = None) → Union[ndarray, csr_matrix][source]
Helper to obtain the YBus matrix from PowerWorld (in Matlab sparse
matrix format) and then convert to scipy csr_matrix by default.
:param full: Convert the csr_matrix to the numpy array (full matrix).
@@ -530,7 +530,7 @@
-
-get_branch_admittance()[source]
+get_branch_admittance()[source]
Helper function to get the branch admittance matrix, usually known as
Yf and Yt.
:returns: A Yf sparse matrix and a Yt sparse matrix
@@ -538,14 +538,14 @@
-
-get_shunt_admittance()[source]
+get_shunt_admittance()[source]
Get shunt admittance Ysh.
:return: A Ysh sparse matrix
-
-get_jacobian(full=False)[source]
+get_jacobian(full=False)[source]
Helper function to get the Jacobian matrix, by default return a
scipy sparse matrix in the csr format
:param full: Convert the csr_matrix to the numpy array (full matrix).
@@ -553,31 +553,40 @@
-
-to_graph(node: str = 'bus', geographic: bool = False, directed: bool = False, node_attr=None, edge_attr=None) → Union[MultiGraph, MultiDiGraph][source]
+to_graph(node: str = 'bus', geographic: bool = False, directed: bool = False, node_attr=None, edge_attr=None) → Union[MultiGraph, MultiDiGraph][source]
Generate the graph network model (NetworkX) from the topology.
Currently supports the bus-level topology and the inter-substation
level topology. Parallel lines (if exist) are preserved in the
-model.
-:param edge_attr: A valid field name(str) or iterable of
+model.
+
+- Parameters
+
+edge_attr – A valid field name(str) or iterable of
field names that are used to retrieve values and add them to the
graph as edge attributes. All fields belonging to object branch are
-available.
-:param node_attr: A valid field name(str) or iterable of
+available.
+node_attr – A valid field name(str) or iterable of
field names that are used to retrieve values and add them to the
graph as node attributes. All fields belonging to the node type are
-available.
-:param directed: Whether to convert to a directed graph (based on
-the direction of real power flow).
-:param geographic: Include latitude and longitude in the node’s
+available.
+directed – Whether to convert to a directed graph (based on
+the direction of real power flow).
+geographic – Include latitude and longitude in the node’s
attributes. If geographic information is unavailable in the case,
-the latitude and the longitude will be NaN.
-:param node: Elements to be represented by nodes. Only ‘bus’ or
-‘substation’ is supported.
+the latitude and the longitude will be NaN.
+node – Elements to be represented by nodes. Only ‘bus’ or
+‘substation’ is supported.
+
+
+- Returns
+A network graph
+
+
-
-get_lodf_matrix(precision: int = 3, method: str = 'DC', post: bool = True, raw: bool = False)[source]
+get_lodf_matrix(precision: int = 3, method: str = 'DC', post: bool = True, raw: bool = False)[source]
Obtain LODF matrix in numpy array or scipy sparse matrix.
By default, it obtains the lodf matrix directly from PW. If size
is larger than 1000, then precision will be applied to filter out
@@ -606,7 +615,7 @@
-
-get_incidence_matrix()[source]
+get_incidence_matrix()[source]
Obtain the incidence matrix.
- Returns
@@ -617,7 +626,7 @@
-
-get_shift_factor_matrix(method: str = 'DC')[source]
+get_shift_factor_matrix(method: str = 'DC')[source]
Calculate the injection shift factor matrix using the auxiliary
script CalculateShiftFactorsMultipleElement.
@@ -633,53 +642,44 @@
-
-get_shift_factor_matrix_fast(precision: int = 4)[source]
+get_shift_factor_matrix_fast()[source]
Calculate the injection shift factor matrix directly using the incidence
matrix and the susceptance matrix. This method should be much faster than
the PW script command for large cases.
-- Parameters
-precision – Default is 4 decimals. Integer only.
-
-- Returns
-A dense float matrix in the numpy array format.
+- Returns
+A dense float matrix in the numpy array format.
-
-get_ptdf_matrix_fast(precision: int = 4)[source]
+get_ptdf_matrix_fast()[source]
Calculate the power transfer distribution factor natively. This method should be much
faster than the PW script command for large cases.
-- Parameters
-precision – Default is 4 decimals. Integer only.
-
-- Returns
-A dense float matrix in the numpy array format.
+- Returns
+A dense float matrix in the numpy array format.
-
-get_lodf_matrix_fast(precision: int = 4)[source]
+get_lodf_matrix_fast()[source]
Calculate the line outage distribution factor natively. This method should be much
faster than the PW script command for large cases.
-- Parameters
-precision – Default is 4 decimals. Integer only.
-
-- Returns
-A dense float matrix in the numpy array format.
+- Returns
+A dense float matrix in the numpy array format.
-
-fast_n1_test()[source]
+fast_n1_test()[source]
A pure LODF-based fast N-1 contingency analysis implementation.
- Returns
@@ -690,14 +690,14 @@
-
-fast_n2_islanding_detection()[source]
+fast_n2_islanding_detection()[source]
Quickly identify the N-2 islanding CTGs using LODF
returns: A tuple with the number of islanding CTGs and the islanding matrix
-
-change_to_temperature(T: Union[int, float, ndarray], R25=7.283, R75=8.688)[source]
+change_to_temperature(T: Union[int, float, ndarray], R25=7.283, R75=8.688)[source]
Change line resistance according to temperature.
The default coefficients are from IEEE Std 738-2012.
Note: The original case has to be set for 25 degree Celsius.
@@ -716,7 +716,7 @@
-
-run_contingency_analysis(option: str = 'N-1', validate: bool = False)[source]
+run_contingency_analysis(option: str = 'N-1', validate: bool = False)[source]
ESA implementation of fast N-1 and N-2 contingency analysis.
The case is expected to have a valid power flow state.
Run SolvePowerFlow first if you are not sure.
@@ -736,7 +736,7 @@
-
-run_robustness_analysis()[source]
+run_robustness_analysis()[source]
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
@@ -754,7 +754,7 @@
-
-run_ecological_analysis(target: str = 'MW', split_generator: bool = True)[source]
+run_ecological_analysis(target: str = 'MW', split_generator: bool = True)[source]
This method is leveraging applied ecological network analysis to quantify
the varity of robustness of the power system.
Reference:
@@ -784,7 +784,7 @@
-
-n1_fast(c1_isl, count, lodf, f, lim)[source]
+n1_fast(c1_isl, count, lodf, f, lim)[source]
A modified fast N-1 method.
- Parameters
@@ -804,7 +804,7 @@
-
-n1_protect(margins, lines, lim)[source]
+n1_protect(margins, lines, lim)[source]
Adjust line limits to eliminate N-1 contingencies.
- Parameters
@@ -822,7 +822,7 @@
-
-n2_fast(c1_isl, count, lodf, f, lim)[source]
+n2_fast(c1_isl, count, lodf, f, lim)[source]
A modified fast N-2 method.
- Parameters
@@ -842,7 +842,7 @@
-
-n2_bruteforce(count, A0, lodf, lim, f)[source]
+n2_bruteforce(count, A0, lodf, lim, f)[source]
Bruteforce for fast N-2 method
- Parameters
@@ -862,7 +862,7 @@
-
-ctg_autoinsert(object_type: str, options: Union[None, dict] = None)[source]
+ctg_autoinsert(object_type: str, options: Union[None, dict] = None)[source]
Auto insert contingencies.
- Parameters
@@ -880,7 +880,7 @@
-
-ctg_solveall()[source]
+ctg_solveall()[source]
Solve all of the contingencies that are not marked to be skipped.
- Returns
@@ -891,7 +891,7 @@
-
-update_ui() → None[source]
+update_ui() → None[source]
Re-render the PowerWorld user interface (UI).
- Returns
@@ -902,7 +902,7 @@
-
-ChangeParameters(ObjectType: str, ParamList: list, Values: list) → None[source]
+ChangeParameters(ObjectType: str, ParamList: list, Values: list) → None[source]
The ChangeParameters function has been replaced by the
ChangeParametersSingleElement function. ChangeParameters
can still be called as before, but will now just automatically
@@ -938,7 +938,7 @@
+ChangeParametersSingleElement(ObjectType: str, ParamList: list, Values: list) → None[source]
Set a list of parameters for a single object.
PowerWorld Documentation
@@ -959,7 +959,7 @@
-
-ChangeParametersMultipleElement(ObjectType: str, ParamList: list, ValueList: list) → None[source]
+ChangeParametersMultipleElement(ObjectType: str, ParamList: list, ValueList: list) → None[source]
Set parameters for multiple objects of the same type.
PowerWorld Documentation
@@ -990,7 +990,7 @@
-
-ChangeParametersMultipleElementFlatInput(ObjectType: str, ParamList: list, NoOfObjects: int, ValueList: list) → None[source]
+ChangeParametersMultipleElementFlatInput(ObjectType: str, ParamList: list, NoOfObjects: int, ValueList: list) → None[source]
The ChangeParametersMultipleElementFlatInput function allows
you to set parameters for multiple objects of the same type in
a case loaded into the Simulator Automation Server. This
@@ -1031,14 +1031,14 @@
-
-CloseCase()[source]
+CloseCase()[source]
Closes case without saving changes.
PowerWorld documentation
+GetCaseHeader(filename: Optional[str] = None) → Tuple[str][source]
The GetCaseHeader function is used to extract the case header
information from the file specified. A tuple of strings
containing the contents of the case header or description is
@@ -1058,7 +1058,7 @@
-
-GetFieldList(ObjectType: str, copy=False) → DataFrame[source]
+GetFieldList(ObjectType: str, copy=False) → DataFrame[source]
Get all fields associated with a given ObjectType.
- Parameters
@@ -1080,7 +1080,7 @@
+GetParametersSingleElement(ObjectType: str, ParamList: list, Values: list) → Series[source]
Request values of specified fields for a particular object.
PowerWorld Documentation
@@ -1116,7 +1116,7 @@
-
-GetParametersMultipleElement(ObjectType: str, ParamList: list, FilterName: str = '') → Optional[DataFrame][source]
+GetParametersMultipleElement(ObjectType: str, ParamList: list, FilterName: str = '') → Optional[DataFrame][source]
Request values of specified fields for a set of objects in
the load flow case.
PowerWorld Documentation
@@ -1156,7 +1156,7 @@
-
-GetParametersMultipleElementFlatOutput(ObjectType: str, ParamList: list, FilterName: str = '') → Union[None, Tuple[str]][source]
+GetParametersMultipleElementFlatOutput(ObjectType: str, ParamList: list, FilterName: str = '') → Union[None, Tuple[str]][source]
This function operates the same as the
GetParametersMultipleElement function, only with one notable
difference. The values returned as the output of the function
@@ -1202,7 +1202,7 @@
-
-GetParameters(ObjectType: str, ParamList: list, Values: list) → Series[source]
+GetParameters(ObjectType: str, ParamList: list, Values: list) → Series[source]
This function is maintained in versions of Simulator later
than version 9 for compatibility with Simulator version 9. This
function will call the GetParametersSingleElement implicitly.
@@ -1240,7 +1240,7 @@
-
-GetSpecificFieldList(ObjectType: str, FieldList: List[str]) → DataFrame[source]
+GetSpecificFieldList(ObjectType: str, FieldList: List[str]) → DataFrame[source]
The GetSpecificFieldList function is used to return identifying
information about specific fields used by an object type. Note
that in many cases simply using the GetFieldList method is
@@ -1274,7 +1274,7 @@
-
-GetSpecificFieldMaxNum(ObjectType: str, Field: str) → int[source]
+GetSpecificFieldMaxNum(ObjectType: str, Field: str) → int[source]
The GetSpecificFieldMaxNum function is used to return the
maximum number of a fields that use a particular variablename
for a specific object type.
@@ -1308,7 +1308,7 @@
-
-ListOfDevices(ObjType: str, FilterName='') → Union[None, DataFrame][source]
+ListOfDevices(ObjType: str, FilterName='') → Union[None, DataFrame][source]
Request a list of objects and their key fields. This function
is general, and you may be better off running more specific
methods like “get_gens”
@@ -1337,7 +1337,7 @@
-
-ListOfDevicesAsVariantStrings(ObjType: str, FilterName='') → tuple[source]
+ListOfDevicesAsVariantStrings(ObjType: str, FilterName='') → tuple[source]
While this method is implemented, you are almost certainly
better off using ListOfDevices instead. Since this method isn’t
particularly useful, no type casting will be performed on the
@@ -1376,7 +1376,7 @@
-
-ListOfDevicesFlatOutput(ObjType: str, FilterName='') → tuple[source]
+ListOfDevicesFlatOutput(ObjType: str, FilterName='') → tuple[source]
While this method is implemented, you are almost certainly
better off using ListOfDevices instead. Since this method isn’t
particularly useful, no type casting, data type changing, or
@@ -1424,7 +1424,7 @@
-
-LoadState() → None[source]
+LoadState() → None[source]
LoadState is used to load the system state previously saved
with the SaveState function. Note that LoadState will not
properly function if the system topology has changed due to the
@@ -1434,7 +1434,7 @@
-
-OpenCase(FileName: Optional[str] = None) → None[source]
+OpenCase(FileName: Optional[str] = None) → None[source]
Load PowerWorld case into the automation server.
- Parameters
@@ -1452,7 +1452,7 @@
-
-OpenCaseType(FileName: str, FileType: str, Options: Optional[Union[list, str]] = None) → None[source]
+OpenCaseType(FileName: str, FileType: str, Options: Optional[Union[list, str]] = None) → None[source]
- The OpenCaseType function will load a PowerWorld Simulator load
- flow file into the Simulator Automation Server. This is similar
to opening a file using the File > Open Case menu option in
@@ -1483,7 +1483,7 @@
-
-ProcessAuxFile(FileName)[source]
+ProcessAuxFile(FileName)[source]
Load a PowerWorld Auxiliary file into SimAuto. This allows
you to create a text file (conforming to the PowerWorld
Auxiliary file format) that can list a set of data changes and
@@ -1499,7 +1499,7 @@
-
-RunScriptCommand(Statements)[source]
+RunScriptCommand(Statements)[source]
Execute a list of script statements. The script actions are
those included in the script sections of auxiliary files.
PowerWorld documentation
@@ -1508,7 +1508,7 @@
-
-SaveCase(FileName=None, FileType='PWB', Overwrite=True)[source]
+SaveCase(FileName=None, FileType='PWB', Overwrite=True)[source]
Save the current case to file.
PowerWorld documentation
@@ -1544,7 +1544,7 @@
-
-SaveState() → None[source]
+SaveState() → None[source]
SaveState is used to save the current state of the power
system. This can be useful if you are interested in comparing
various cases, much as the “Difference Flows” feature works in
@@ -1554,7 +1554,7 @@
-
-SendToExcel(ObjectType: str, FilterName: str, FieldList) → None[source]
+SendToExcel(ObjectType: str, FilterName: str, FieldList) → None[source]
Send data from SimAuto to an Excel spreadsheet. While ESA
provides this function, we strongly recommend you to use the
GetParametersMultipleElement
function and save the DataFrame
@@ -1592,7 +1592,7 @@
-
-TSGetContingencyResults(CtgName: str, ObjFieldList: List[str], StartTime: Union[None, int, float] = None, StopTime: Union[None, int, float] = None) → Union[Tuple[None, None], Tuple[DataFrame, DataFrame]][source]
+TSGetContingencyResults(CtgName: str, ObjFieldList: List[str], StartTime: Union[None, int, float] = None, StopTime: Union[None, int, float] = None) → Union[Tuple[None, None], Tuple[DataFrame, DataFrame]][source]
WARNING: This function should only be used after the simulation
is run (for example, use this after running script commands
TSSolveAll or TSSolve).
@@ -1661,7 +1661,7 @@
-
-WriteAuxFile(FileName: str, FilterName: str, ObjectType: str, FieldList: Union[list, str], ToAppend=True)[source]
+WriteAuxFile(FileName: str, FilterName: str, ObjectType: str, FieldList: Union[list, str], ToAppend=True)[source]
The WriteAuxFile function can be used to write data from the
case in the Simulator Automation Server to a PowerWorld
Auxiliary file. The name of an advanced filter which was
@@ -1674,7 +1674,7 @@
-
-SolvePowerFlow(SolMethod: str = 'RECTNEWT') → None[source]
+SolvePowerFlow(SolMethod: str = 'RECTNEWT') → None[source]
Run the SolvePowerFlow command.
- Parameters
@@ -1695,7 +1695,7 @@
-
-OpenOneLine(filename: str, view: str = '', FullScreen: str = 'NO', ShowFull: str = 'NO', LinkMethod: str = 'LABELS', Left: float = 0.0, Top: float = 0.0, Width: float = 0.0, Height: float = 0.0) → None[source]
+OpenOneLine(filename: str, view: str = '', FullScreen: str = 'NO', ShowFull: str = 'NO', LinkMethod: str = 'LABELS', Left: float = 0.0, Top: float = 0.0, Width: float = 0.0, Height: float = 0.0) → None[source]
Use this function to open a oneline diagram. This function
can be used to associate onelines with a PWB file.
@@ -1736,7 +1736,7 @@
-
-CloseOneline(OnelineName: str = '') → None[source]
+CloseOneline(OnelineName: str = '') → None[source]
Use this action to close an open oneline diagram without
saving it. If the name is omitted, the last focused oneline
diagram will be closed.
@@ -1812,7 +1812,7 @@
-
-esa.saw.df_to_aux(fp, df, object_name: str)[source]
+esa.saw.df_to_aux(fp, df, object_name: str)[source]
Convert a dataframe to PW aux/axd data section.
- Parameters
@@ -1827,13 +1827,13 @@
-
-esa.saw.convert_to_windows_path(p)[source]
+esa.saw.convert_to_windows_path(p)[source]
Given a path, p, convert it to a Windows path.
-
-esa.saw.convert_list_to_variant(list_in: list) → VARIANT[source]
+esa.saw.convert_list_to_variant(list_in: list) → VARIANT[source]
Given a list, convert to a variant array.
- Parameters
@@ -1844,7 +1844,7 @@
-
-esa.saw.convert_nested_list_to_variant(list_in: list) → List[VARIANT][source]
+esa.saw.convert_nested_list_to_variant(list_in: list) → List[VARIANT][source]
Given a list of lists, convert to a variant array.
- Parameters
@@ -1855,21 +1855,21 @@
-
-exception esa.saw.Error[source]
+exception esa.saw.Error[source]
Bases: Exception
Base class for exceptions in this module.
-
-exception esa.saw.PowerWorldError[source]
+exception esa.saw.PowerWorldError[source]
Bases: Error
Raised when PowerWorld reports an error following a SimAuto call.
-
-exception esa.saw.COMError[source]
+exception esa.saw.COMError[source]
Bases: Error
Raised when attempting to call a SimAuto function results in an
error.
@@ -1877,7 +1877,7 @@
-
-exception esa.saw.CommandNotRespectedError[source]
+exception esa.saw.CommandNotRespectedError[source]
Bases: Error
Raised if a command sent into PowerWorld is not respected, but
PowerWorld itself does not raise an error. This exception should
diff --git a/docs/html/objects.inv b/docs/html/objects.inv
index 2f4ed4b4a88b438d9ba68465bfb348b20c4dd1f2..bcd00ab6f61ce0561edd405121eecc5136949c4b 100644
GIT binary patch
delta 12
TcmZ3+y^MQ;HKXxHn=DoU8lMBc
delta 12
TcmZ3+y^MQ;HKWl+n=DoU8kz&W
diff --git a/docs/html/overview.html b/docs/html/overview.html
index b2b2583..483cbb1 100644
--- a/docs/html/overview.html
+++ b/docs/html/overview.html
@@ -318,7 +318,7 @@
Testing Coverage