|
6 | 6 | <meta charset="utf-8" /> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> |
8 | 8 |
|
9 | | - <title>esa API Documentation — ESA 1.2.5 documentation</title> |
| 9 | + <title>esa API Documentation — ESA 1.2.6 documentation</title> |
10 | 10 | <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> |
12 | 12 | <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> |
|
1221 | 1221 | <dd><p>Clean up for the PowerWorld COM object</p> |
1222 | 1222 | </dd></dl> |
1223 | 1223 |
|
| 1224 | +<dl class="py method"> |
| 1225 | +<dt class="sig sig-object py" id="esa.saw.SAW.get_branch_admittance"> |
| 1226 | +<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> |
| 1227 | +<dd><p>Helper function to get the branch admittance matrix, usually known as |
| 1228 | +Yf and Yt. |
| 1229 | +:returns: A Yf sparse matrix and a Yt sparse matrix</p> |
| 1230 | +</dd></dl> |
| 1231 | + |
1224 | 1232 | <dl class="py method"> |
1225 | 1233 | <dt class="sig sig-object py" id="esa.saw.SAW.get_incidence_matrix"> |
1226 | 1234 | <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 | 1322 | </dl> |
1315 | 1323 | </dd></dl> |
1316 | 1324 |
|
| 1325 | +<dl class="py method"> |
| 1326 | +<dt class="sig sig-object py" id="esa.saw.SAW.get_shunt_admittance"> |
| 1327 | +<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> |
| 1328 | +<dd><p>Get shunt admittance Ysh. |
| 1329 | +:return: A Ysh sparse matrix</p> |
| 1330 | +</dd></dl> |
| 1331 | + |
1317 | 1332 | <dl class="py method"> |
1318 | 1333 | <dt class="sig sig-object py" id="esa.saw.SAW.get_version_and_builddate"> |
1319 | 1334 | <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">→</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 | 1547 | <dd><p>Given a path, p, convert it to a Windows path.</p> |
1533 | 1548 | </dd></dl> |
1534 | 1549 |
|
| 1550 | +<dl class="py function"> |
| 1551 | +<dt class="sig sig-object py" id="esa.saw.df_to_aux"> |
| 1552 | +<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> |
| 1553 | +<dd><p>Convert a dataframe to PW aux/axd data section.</p> |
| 1554 | +<dl class="field-list simple"> |
| 1555 | +<dt class="field-odd">Parameters</dt> |
| 1556 | +<dd class="field-odd"><ul class="simple"> |
| 1557 | +<li><p><strong>fp</strong> – file handler</p></li> |
| 1558 | +<li><p><strong>df</strong> – dataframe</p></li> |
| 1559 | +<li><p><strong>object_name</strong> – object type</p></li> |
| 1560 | +</ul> |
| 1561 | +</dd> |
| 1562 | +</dl> |
| 1563 | +</dd></dl> |
| 1564 | + |
1535 | 1565 | </section> |
1536 | 1566 | </section> |
1537 | 1567 |
|
|
0 commit comments