Skip to content

Commit

Permalink
Minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
PMeira committed Feb 13, 2024
1 parent 0b83752 commit 01ff549
Show file tree
Hide file tree
Showing 25 changed files with 93 additions and 93 deletions.
10 changes: 5 additions & 5 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>&lt;no title&gt; &#8212; OpenDSSDirect.py 0.9.0 documentation</title>
<title>&lt;no title&gt; &#8212; OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
<script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>

<script src="_static/documentation_options.js?v=2a76c96f"></script>
<script src="_static/documentation_options.js?v=1c0a46c0"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
Expand Down Expand Up @@ -137,8 +137,8 @@



<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>`);</script>
<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>`);</script>


</a></div>
Expand Down Expand Up @@ -348,7 +348,7 @@ <h2> Contents </h2>
<article class="bd-article">

<p>View the last compiled version of the API docs at <a class="reference external" href="https://dss-extensions.org/OpenDSSDirect.py/">https://dss-extensions.org/OpenDSSDirect.py/</a></p>
<p>More links at <a class="reference external" href="https://dss-extensions.org/">https://dss-extensions.org/</a> and other notes at <a class="reference external" href="https://github.com/dss-extensions/dss-extensions/blob/main/python_apis.md">DSS-Extensions — OpenDSS: Overview of Python APIs</a>.</p>
<p>More links at <a class="reference external" href="https://dss-extensions.org/">https://dss-extensions.org/</a> and other notes at <a class="reference external" href="https://github.com/dss-extensions/dss-extensions/blob/main/docs/python_apis.md">DSS-Extensions — OpenDSS: Overview of Python APIs</a>.</p>


</article>
Expand Down
2 changes: 1 addition & 1 deletion _sources/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
View the last compiled version of the API docs at https://dss-extensions.org/OpenDSSDirect.py/

More links at https://dss-extensions.org/ and other notes at [DSS-Extensions — OpenDSS: Overview of Python APIs](https://github.com/dss-extensions/dss-extensions/blob/main/python_apis.md).
More links at https://dss-extensions.org/ and other notes at [DSS-Extensions — OpenDSS: Overview of Python APIs](https://github.com/dss-extensions/dss-extensions/blob/main/docs/python_apis.md).
4 changes: 2 additions & 2 deletions _sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![PyPI](https://img.shields.io/pypi/v/OpenDSSDirect.py.svg)](https://pypi.python.org/pypi/OpenDSSDirect.py/) <img alt="Supports Linux" src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black"> <img alt="Supports macOS" src="https://img.shields.io/badge/macOS-000000?logo=apple&logoColor=white"> <img alt="Supports Microsoft Windows" src="https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white">

OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface to [our customized implementation](https://github.com/dss-extensions/dss_capi) of [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx) using [DSS-Python](https://dss-extensions.org/dss_python/).
OpenDSS is an open-source electric power distribution system simulator.
OpenDSS is an open-source electric power distribution system simulator [distributed by EPRI](https://sourceforge.net/p/electricdss/).

OpenDSSDirect.py is part of DSS-Extensions, a larger effort to port the original OpenDSS to support more platforms (OSs, processor architectures), programming languages, and extend both the OpenDSS engine and API, represented in the AltDSS engine:

Expand All @@ -27,7 +27,7 @@ flowchart TD

</center>

Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API, including most of its limitations. For an alternative API which exposes all OpenDSS objects, batch operations, and a more intuitive API, check [AltDSS-Python](https://dss-extensions.org/AltDSS-Python/). If required, users can mix all three packages in the same project to access some of their unique features.
Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API (closer to the COM implementation). For an alternative API which exposes all OpenDSS objects, batch operations, and a more intuitive API, check [AltDSS-Python](https://dss-extensions.org/AltDSS-Python/). If required, users can mix all three packages in the same project to access some of their unique features.

<!-- TODO: update the links to the final links after the main site is updated -->

Expand Down
6 changes: 3 additions & 3 deletions _sources/notebooks/GettingStarted.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -447,15 +447,15 @@
"source": [
"## Multiple engines in the same process\n",
"\n",
"Follow the notebook for an example: [Multiple DSS engines and multithreading](https://dss-extensions.org/OpenDSSDirect.py/notebooks/Multithreading.html).\n",
"Follow the notebook for an example: [Multiple DSS engines and multithreading](https://dss-extensions.org/OpenDSSDirect.py/notebooks/Multithreading).\n",
"\n",
"## Plotting and notebook integration\n",
"\n",
"For examples on how to use the plot commands from OpenDSS, including an extensive gallery, see [Integrated plotting in Python](https://dss-extensions.org/dss_python/examples/Plotting.html).\n",
"For examples on how to use the plot commands from OpenDSS, including an extensive gallery, see [Integrated plotting in Python](https://dss-extensions.org/dss_python/examples/Plotting).\n",
"\n",
"## JSON exports and imports\n",
"\n",
"Another on-going effort is JSON export and import: https://dss-extensions.org/dss_python/examples/JSON.html"
"Another on-going effort is JSON export and import: https://dss-extensions.org/dss_python/examples/JSON"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion _sources/notebooks/Installation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Recommended**: Use [Miniconda](https://conda.io/miniconda.html) or [Anaconda](https://www.continuum.io/downloads) to install Python"
"**Recommended**: Use [Miniconda](https://conda.io/miniconda.html) or [Anaconda](https://www.anaconda.com/download/) to install Python"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion _sources/notebooks/VoltageProfilePlot.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"See also [Plotting and notebook integration](https://dss-extensions.org/dss_python/examples/Plotting/) for an extensive example gallery."
"See also [Plotting and notebook integration](https://dss-extensions.org/dss_python/examples/Plotting) for an extensive example gallery."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion _sources/updating_to_0.9.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There are also a couple of deprecation warnings introduced to signal some change

- The classes also handle a common mistake of new users, which is using OpenDSSDirect.py as DSS-Python or the COM API, accidentally replacing the functions/methods with the intended values instead. That is, something like `from opendssdirect import dss as odd; odd.Text.Command = 'clear'` now results in an error.

- The old `Iterator` class is deprecated since all iterable classes should now support the native iterator protocol in Python. That is `[load.kW() for load in odd.Loads]` now works. Limitations from OpenDSS still applies (a single object of a certain type must be active, etc.).
- The old `Iterator` class is deprecated since all iterable classes should now support the native iterator protocol in Python. That is `[load.kW() for load in odd.Loads]` now works. The general behavior from OpenDSS still applies (a single object of a certain type must be active, etc.).

- `opendssdirect.run_command` is also deprecated due to the lack of direct error handling. We noticed this was resulting in error being ignored by many users, especially new users.

Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.9.0',
VERSION: '0.9.0.post3+g81daed3',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
8 changes: 4 additions & 4 deletions enumerations.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Enumerations &#8212; OpenDSSDirect.py 0.9.0 documentation</title>
<title>Enumerations &#8212; OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
<script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>

<script src="_static/documentation_options.js?v=2a76c96f"></script>
<script src="_static/documentation_options.js?v=1c0a46c0"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
Expand Down Expand Up @@ -136,8 +136,8 @@



<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>`);</script>
<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>`);</script>


</a></div>
Expand Down
8 changes: 4 additions & 4 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; OpenDSSDirect.py 0.9.0 documentation</title>
<title>Index &#8212; OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
<script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>

<script src="_static/documentation_options.js?v=2a76c96f"></script>
<script src="_static/documentation_options.js?v=1c0a46c0"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
Expand Down Expand Up @@ -138,8 +138,8 @@



<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>`);</script>
<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>`);</script>


</a></div>
Expand Down
12 changes: 6 additions & 6 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>OpenDSSDirect.py &#8212; OpenDSSDirect.py 0.9.0 documentation</title>
<title>OpenDSSDirect.py &#8212; OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
<script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>

<script src="_static/documentation_options.js?v=2a76c96f"></script>
<script src="_static/documentation_options.js?v=1c0a46c0"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
Expand Down Expand Up @@ -140,8 +140,8 @@



<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>`);</script>
<img src="_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>
<script>document.write(`<img src="_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>`);</script>


</a></div>
Expand Down Expand Up @@ -363,7 +363,7 @@ <h2> Contents </h2>
<h1>OpenDSSDirect.py<a class="headerlink" href="#opendssdirect-py" title="Link to this heading">#</a></h1>
<p><a class="reference external" href="https://pypi.python.org/pypi/OpenDSSDirect.py/"><img alt="PyPI" src="https://img.shields.io/pypi/v/OpenDSSDirect.py.svg" /></a> <img alt="Supports Linux" src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black"> <img alt="Supports macOS" src="https://img.shields.io/badge/macOS-000000?logo=apple&logoColor=white"> <img alt="Supports Microsoft Windows" src="https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white"></p>
<p>OpenDSSDirect.py is a cross-platform Python package implements a “direct” library interface to <a class="reference external" href="https://github.com/dss-extensions/dss_capi">our customized implementation</a> of <a class="reference external" href="http://smartgrid.epri.com/SimulationTool.aspx">OpenDSS</a> using <a class="reference external" href="https://dss-extensions.org/dss_python/">DSS-Python</a>.
OpenDSS is an open-source electric power distribution system simulator.</p>
OpenDSS is an open-source electric power distribution system simulator <a class="reference external" href="https://sourceforge.net/p/electricdss/">distributed by EPRI</a>.</p>
<p>OpenDSSDirect.py is part of DSS-Extensions, a larger effort to port the original OpenDSS to support more platforms (OSs, processor architectures), programming languages, and extend both the OpenDSS engine and API, represented in the AltDSS engine:</p>
<p align="center">
<img alt="Overview of related projects" src="https://github.com/dss-extensions/dss-extensions/blob/main/images/repomap.png?raw=true">
Expand All @@ -378,7 +378,7 @@ <h1>OpenDSSDirect.py<a class="headerlink" href="#opendssdirect-py" title="Link t
P --- ODDPY[&quot;OpenDSSDirect.py\n(opendssdirect package)&quot;]
P --- ALTDSSPY[&quot;&lt;a href='https://dss-extensions.org/AltDSS-Python/'&gt;AltDSS-Python\n(altdss package)&lt;/a&gt;&quot;]
</div></center>
<p>Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API, including most of its limitations. For an alternative API which exposes all OpenDSS objects, batch operations, and a more intuitive API, check <a class="reference external" href="https://dss-extensions.org/AltDSS-Python/">AltDSS-Python</a>. If required, users can mix all three packages in the same project to access some of their unique features.</p>
<p>Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API (closer to the COM implementation). For an alternative API which exposes all OpenDSS objects, batch operations, and a more intuitive API, check <a class="reference external" href="https://dss-extensions.org/AltDSS-Python/">AltDSS-Python</a>. If required, users can mix all three packages in the same project to access some of their unique features.</p>
<!-- TODO: update the links to the final links after the main site is updated -->
<section id="troubleshooting">
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading">#</a></h2>
Expand Down
10 changes: 5 additions & 5 deletions notebooks/ActiveClass.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Using ActiveClass interface &#8212; OpenDSSDirect.py 0.9.0 documentation</title>
<title>Using ActiveClass interface &#8212; OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
<script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>

<script src="../_static/documentation_options.js?v=2a76c96f"></script>
<script src="../_static/documentation_options.js?v=1c0a46c0"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
Expand Down Expand Up @@ -137,8 +137,8 @@



<img src="../_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>
<script>document.write(`<img src="../_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0 documentation - Home"/>`);</script>
<img src="../_static/opendssdirect.svg" class="logo__image only-light" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>
<script>document.write(`<img src="../_static/opendssdirect-dark.svg" class="logo__image only-dark" alt="OpenDSSDirect.py 0.9.0.post3+g81daed3 documentation - Home"/>`);</script>


</a></div>
Expand Down Expand Up @@ -379,7 +379,7 @@ <h1>Using ActiveClass interface<a class="headerlink" href="#using-activeclass-in
</div>
</div>
<div class="cell_output docutils container">
<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>/tmp/ipykernel_32505/608750254.py:1: DeprecationWarning: class_to_dataframe is deprecated; it will not be removed any time soon, using JSON exports is preferable. Watch AltDSS-Python for future alternatives, including native dataframes.
<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>/tmp/ipykernel_702/608750254.py:1: DeprecationWarning: class_to_dataframe is deprecated; it will not be removed any time soon, using JSON exports is preferable. Watch AltDSS-Python for future alternatives, including native dataframes.
dss.utils.class_to_dataframe(&#39;Storage&#39;).transpose()
</pre></div>
</div>
Expand Down
Loading

0 comments on commit 01ff549

Please sign in to comment.