[skip ci] Docs: small tweaks, fix links

dss-extensions · Feb 13, 2024 · 0028e02 · 0028e02
1 parent 81daed3
commit 0028e02
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,9 @@
 [![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://dss-extensions.org/OpenDSSDirect.py)
 
 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://github.com/dss-extensions/dss_python/).
-OpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/dss-extensions/OpenDSSDirect.jl) for a similar package in Julia, and for more context about this project and its components (including alternatives in MATLAB, C++ and C#/.NET), please check [https://dss-extensions.org/](https://dss-extensions.org/) and our hub repository at [dss-extensions/dss-extensions](https://github.com/dss-extensions/dss-extensions) for more documentation, discussions and the [FAQ](https://github.com/dss-extensions/dss-extensions#faq).
+OpenDSS is an open-source distribution system simulator [distributed by EPRI](https://sourceforge.net/p/electricdss/). See [OpenDSSDirect.jl](https://github.com/dss-extensions/OpenDSSDirect.jl) for a similar package in Julia, and for more context about this project and its components (including alternatives in MATLAB, C++, C#/.NET, Go, and Rust), please check [https://dss-extensions.org/](https://dss-extensions.org/) and our hub repository at [dss-extensions/dss-extensions](https://github.com/dss-extensions/dss-extensions) for more documentation, discussions and the [FAQ](https://github.com/dss-extensions/dss-extensions#faq).
+
+An alternative Python package is being developed in [AltDSS-Python](https://dss-extensions.org/AltDSS-Python/). It can be used together with OpenDSSDirect.py.
 
 
 <p align="center">

diff --git a/docs/README.md b/docs/README.md
@@ -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).
diff --git a/docs/index.md b/docs/index.md
@@ -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:
 
@@ -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 -->
 

diff --git a/docs/notebooks/GettingStarted.ipynb b/docs/notebooks/GettingStarted.ipynb
@@ -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"
    ]
   },
   {

diff --git a/docs/notebooks/Installation.ipynb b/docs/notebooks/Installation.ipynb
@@ -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"
    ]
   },
   {

diff --git a/docs/notebooks/VoltageProfilePlot.ipynb b/docs/notebooks/VoltageProfilePlot.ipynb
@@ -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."
    ]
   }
  ],

diff --git a/docs/updating_to_0.9.md b/docs/updating_to_0.9.md
@@ -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. 
 

diff --git a/opendssdirect/utils.py b/opendssdirect/utils.py
@@ -164,7 +164,7 @@ def class_to_dataframe(class_name, dss=None, transform_string=None, clean_data=N
 
     For alternatives:
     
-    - Check the functions for JSON output, such as [`Circuit.ToJSON()`](#opendssdirect.Circuit.ICircuit.ToJSON) (whole circuit), [`ActiveClass.ToJSON()`](#opendssdirect.ActiveClass.IActiveClass.ToJSON) (a whole class), and [`Element.ToJSON()`](#opendssdirect.Element.IElement.ToJSON). The DSS-Python examples are a good starting point (all related functions are also available in OpenDSSDirect.py): https://dss-extensions.org/dss_python/examples/JSON/
+    - Check the functions for JSON output, such as [`Circuit.ToJSON()`](#opendssdirect.Circuit.ICircuit.ToJSON) (whole circuit), [`ActiveClass.ToJSON()`](#opendssdirect.ActiveClass.IActiveClass.ToJSON) (a whole class), and [`Element.ToJSON()`](#opendssdirect.Element.IElement.ToJSON). The DSS-Python examples are a good starting point (all related functions are also available in OpenDSSDirect.py): https://dss-extensions.org/dss_python/examples/JSON
     - The JSON output/input, and other future alternatives are based on the work-in-progress AltDSS Schema project. Check https://github.com/dss-extensions/AltDSS-Schema
     
     """