Merge branch 'develop'

mzy2240 · Feb 21, 2022 · 5155966 · 5155966
2 parents f717745 + ffa0aa9
commit 5155966
Show file tree

Hide file tree

Showing 26 changed files with 237 additions and 34 deletions.
diff --git a/README.rst b/README.rst
@@ -76,7 +76,7 @@ The ESA team works hard to ensure ESA is well tested, and we strive for
 testing coverage data for ESA, using `coverage
 <https://pypi.org/project/coverage/>`__.
 
-.. table:: ESA's testing coverage as of 2022-02-10 (Git commit: 41ad7ed)
+.. table:: ESA's testing coverage as of 2022-02-20 (Git commit: 2b5a8ff)
     :widths: auto
     :align: left
 
@@ -85,7 +85,7 @@ testing coverage data for ESA, using `coverage
     +=================+===================+=================+=================+====================+
     | esa/__init__.py |                 2 |               0 |               2 |                100 |
     +-----------------+-------------------+-----------------+-----------------+--------------------+
-    | esa/saw.py      |               752 |               0 |             752 |                100 |
+    | esa/saw.py      |               824 |               0 |             824 |                100 |
     +-----------------+-------------------+-----------------+-----------------+--------------------+
 
 License

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.2.5
+1.2.6
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/esa.doctree b/docs/doctrees/esa.doctree
diff --git a/docs/doctrees/overview.doctree b/docs/doctrees/overview.doctree
diff --git a/docs/doctrees/welcome.doctree b/docs/doctrees/welcome.doctree
diff --git 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: 77715398b7bf42f986e4d37858004ae1
+config: 437d8a7d4ff36783090e9c4c30038663
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git 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.5',
+    VERSION: '1.2.6',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/common_issues.html b/docs/html/common_issues.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Common Issues &#8212; ESA 1.2.5 documentation</title>
+    <title>Common Issues &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/html/esa.html b/docs/html/esa.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>esa API Documentation &#8212; ESA 1.2.5 documentation</title>
+    <title>esa API Documentation &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -1221,6 +1221,14 @@
 <dd><p>Clean up for the PowerWorld COM object</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="esa.saw.SAW.get_branch_admittance">
+<span class="sig-name descname"><span class="pre">get_branch_admittance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_branch_admittance" title="Permalink to this definition">¶</a></dt>
+<dd><p>Helper function to get the branch admittance matrix, usually known as
+Yf and Yt.
+:returns: A Yf sparse matrix and a Yt sparse matrix</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="esa.saw.SAW.get_incidence_matrix">
 <span class="sig-name descname"><span class="pre">get_incidence_matrix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_incidence_matrix" title="Permalink to this definition">¶</a></dt>
@@ -1314,6 +1322,13 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="esa.saw.SAW.get_shunt_admittance">
+<span class="sig-name descname"><span class="pre">get_shunt_admittance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_shunt_admittance" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get shunt admittance Ysh.
+:return: A Ysh sparse matrix</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="esa.saw.SAW.get_version_and_builddate">
 <span class="sig-name descname"><span class="pre">get_version_and_builddate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span></span></span><a class="headerlink" href="#esa.saw.SAW.get_version_and_builddate" title="Permalink to this definition">¶</a></dt>
@@ -1532,6 +1547,21 @@
 <dd><p>Given a path, p, convert it to a Windows path.</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="esa.saw.df_to_aux">
+<span class="sig-prename descclassname"><span class="pre">esa.saw.</span></span><span class="sig-name descname"><span class="pre">df_to_aux</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.df_to_aux" title="Permalink to this definition">¶</a></dt>
+<dd><p>Convert a dataframe to PW aux/axd data section.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>fp</strong> – file handler</p></li>
+<li><p><strong>df</strong> – dataframe</p></li>
+<li><p><strong>object_name</strong> – object type</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 </section>
 

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; ESA 1.2.5 documentation</title>
+    <title>Index &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -35,6 +35,7 @@ <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
  <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
@@ -97,6 +98,14 @@ <h2 id="C">C</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="esa.html#esa.saw.df_to_aux">df_to_aux() (in module esa.saw)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -140,6 +149,8 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="esa.html#esa.saw.SAW.get_branch_admittance">get_branch_admittance() (esa.saw.SAW method)</a>
+</li>
       <li><a href="esa.html#esa.saw.SAW.get_incidence_matrix">get_incidence_matrix() (esa.saw.SAW method)</a>
 </li>
       <li><a href="esa.html#esa.saw.SAW.get_jacobian">get_jacobian() (esa.saw.SAW method)</a>
@@ -152,12 +163,14 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="esa.html#esa.saw.SAW.get_power_flow_results">get_power_flow_results() (esa.saw.SAW method)</a>
 </li>
-      <li><a href="esa.html#esa.saw.SAW.get_version_and_builddate">get_version_and_builddate() (esa.saw.SAW method)</a>
+      <li><a href="esa.html#esa.saw.SAW.get_shunt_admittance">get_shunt_admittance() (esa.saw.SAW method)</a>
 </li>
-      <li><a href="esa.html#esa.saw.SAW.get_ybus">get_ybus() (esa.saw.SAW method)</a>
+      <li><a href="esa.html#esa.saw.SAW.get_version_and_builddate">get_version_and_builddate() (esa.saw.SAW method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="esa.html#esa.saw.SAW.get_ybus">get_ybus() (esa.saw.SAW method)</a>
+</li>
       <li><a href="esa.html#esa.saw.SAW.GetCaseHeader">GetCaseHeader() (esa.saw.SAW method)</a>
 </li>
       <li><a href="esa.html#esa.saw.SAW.GetFieldList">GetFieldList() (esa.saw.SAW method)</a>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Easy SimAuto (ESA) Documentation &#8212; ESA 1.2.5 documentation</title>
+    <title>Easy SimAuto (ESA) Documentation &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/html/installation.html b/docs/html/installation.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Installing ESA &#8212; ESA 1.2.5 documentation</title>
+    <title>Installing ESA &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/html/objects.inv b/docs/html/objects.inv
diff --git a/docs/html/overview.html b/docs/html/overview.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>ESA Overview &#8212; ESA 1.2.5 documentation</title>
+    <title>ESA Overview &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -133,7 +133,7 @@ <h2>Testing Coverage<a class="headerlink" href="#testing-coverage" title="Permal
 <p>The ESA team strives to write good tests with 100% coverage. The table
 below provides the latest test coverage data for ESA.</p>
 <table class="colwidths-auto docutils align-left" id="id3">
-<caption><span class="caption-text">ESA’s testing coverage as of 2022-02-10 (Git commit: 41ad7ed)</span><a class="headerlink" href="#id3" title="Permalink to this table">¶</a></caption>
+<caption><span class="caption-text">ESA’s testing coverage as of 2022-02-20 (Git commit: 2b5a8ff)</span><a class="headerlink" href="#id3" title="Permalink to this table">¶</a></caption>
 <thead>
 <tr class="row-odd"><th class="head"><p>Name</p></th>
 <th class="head"><p>Num. Statements</p></th>
@@ -150,9 +150,9 @@ <h2>Testing Coverage<a class="headerlink" href="#testing-coverage" title="Permal
 <td><p>100</p></td>
 </tr>
 <tr class="row-odd"><td><p>esa/saw.py</p></td>
-<td><p>752</p></td>
+<td><p>824</p></td>
 <td><p>0</p></td>
-<td><p>752</p></td>
+<td><p>824</p></td>
 <td><p>100</p></td>
 </tr>
 </tbody>

diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; ESA 1.2.5 documentation</title>
+    <title>Python Module Index &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Quick Start &#8212; ESA 1.2.5 documentation</title>
+    <title>Quick Start &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/html/search.html b/docs/html/search.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; ESA 1.2.5 documentation</title>
+    <title>Search &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
 

diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/docs/html/snippets.html b/docs/html/snippets.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Examples &#8212; ESA 1.2.5 documentation</title>
+    <title>Examples &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/html/welcome.html b/docs/html/welcome.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Welcome! &#8212; ESA 1.2.5 documentation</title>
+    <title>Welcome! &#8212; ESA 1.2.6 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -357,6 +357,13 @@ <h3>Credits and Thanks<a class="headerlink" href="#credits-and-thanks" title="Pe
 <p>Changes made with each ESA release are listed here. Please note that
 versions prior to 1.0.0 are not listed here, but are still available on
 <a class="reference external" href="https://pypi.org/project/esa/#history">PyPi</a>.</p>
+<section id="version-1-2-6">
+<h3>Version 1.2.6<a class="headerlink" href="#version-1-2-6" title="Permalink to this headline">¶</a></h3>
+<ul class="simple">
+<li><p>Add functions to obtain branch and shunt impedance</p></li>
+<li><p>Add a helper function to convert dataframe into auxiliary(aux/axd) data section</p></li>
+</ul>
+</section>
 <section id="version-1-2-5">
 <h3>Version 1.2.5<a class="headerlink" href="#version-1-2-5" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">

diff --git a/docs/rst/coverage.rst b/docs/rst/coverage.rst
@@ -1,4 +1,4 @@
-.. table:: ESA's testing coverage as of 2022-02-10 (Git commit: 41ad7ed)
+.. table:: ESA's testing coverage as of 2022-02-20 (Git commit: 2b5a8ff)
     :widths: auto
     :align: left
 
@@ -7,5 +7,5 @@
     +=================+===================+=================+=================+====================+
     | esa/__init__.py |                 2 |               0 |               2 |                100 |
     +-----------------+-------------------+-----------------+-----------------+--------------------+
-    | esa/saw.py      |               752 |               0 |             752 |                100 |
+    | esa/saw.py      |               824 |               0 |             824 |                100 |
     +-----------------+-------------------+-----------------+-----------------+--------------------+
diff --git a/docs/rst/welcome/changelog.rst b/docs/rst/welcome/changelog.rst
@@ -2,6 +2,12 @@ Changes made with each ESA release are listed here. Please note that
 versions prior to 1.0.0 are not listed here, but are still available on
 `PyPi <https://pypi.org/project/esa/#history>`__.
 
+Version 1.2.6
+^^^^^^^^^^^^^
+
+* Add functions to obtain branch and shunt impedance
+* Add a helper function to convert dataframe into auxiliary(aux/axd) data section
+
 Version 1.2.5
 ^^^^^^^^^^^^^
 

diff --git a/esa/__init__.py b/esa/__init__.py
@@ -16,4 +16,4 @@
 # Please keep the docstring above up to date with all the imports.
 from .saw import SAW, PowerWorldError, COMError, CommandNotRespectedError,\
     Error
-__version__ = "1.2.5"
+__version__ = "1.2.6"