Merge pull request #78 from dss-extensions/class_iterators

Class iterators and whole package update

.github/ISSUE_TEMPLATE.md

@@ -12,7 +12,7 @@
 You can use the following block of code to find the version of OpenDSSDirect.py that you are using
 
 	```python
-	import opendssdirect as dss
+	from opendssdirect import dss
 	print(dss.__version__)
 	```
 

.github/workflows/tests.yml

@@ -9,8 +9,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
         os: [ubuntu-latest, windows-latest, macos-latest]
+
     runs-on: ${{ matrix.os }}
     steps: 
       - uses: actions/checkout@v3
@@ -24,7 +25,8 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install pandas matplotlib pytest
-          python -m pip install -e .[extras]
+          git fetch --unshallow
+          python -m pip install .[extras]
 
       - name: Test
         run: |
@@ -34,3 +36,8 @@ jobs:
         if: runner.os == 'Linux'
         run: |
           DSS_EXTENSIONS_DEBUG=1 pytest -vv
+
+      - name: Test (activate NumPy on Linux only)
+        if: runner.os == 'Linux'
+        run: |
+          OPENDSSDIRECT_PY_USE_NUMPY=1 pytest -vv

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v1.2.3
+    rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: check-ast
     -   id: check-merge-conflict
--   repo: https://github.com/ambv/black
-    rev: stable
+-   repo: https://github.com/psf/black
+    rev: 23.12.1
     hooks:
     - id: black
-      args: [--line-length=88, --safe]
-      python_version: python3.6
+      args: [--line-length=88, --safe, -S]
+      python_version: python3.7
 

README.md

@@ -5,18 +5,24 @@
 [![PyPI](https://img.shields.io/pypi/v/OpenDSSDirect.py.svg)](https://pypi.python.org/pypi/OpenDSSDirect.py/)
 [![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 [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/).
+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).
 
+
+<p align="center">
+    <img alt="Overview of related projects" src="https://github.com/dss-extensions/dss-extensions/blob/main/images/repomap.png?raw=true">
+</p>
+
+
 *As a reminder, although very compatible, this project is not supported by EPRI.*
 
 **This package is available for Windows, Mac and Linux, including ARM and x86 variants.**
 
-### Documentation
+## Documentation
 
 The documentation for this package can be found [here](http://dss-extensions.org/OpenDSSDirect.py).
 
-### Installation
+## Installation
 
 **Recommended**: Install Python using Miniconda or Anaconda
 
@@ -26,17 +32,18 @@ Open a command line interface and type the following.
 pip install 'OpenDSSDirect.py[extras]'
 ```
 
-See [installation](https://dss-extensions.org/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.
+See the [installation](https://dss-extensions.org/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.
+
+Updating from pre-v0.9 versions? [See the upgrade guide for recommendations.](https://dss-extensions.org/OpenDSSDirect.py/updating_to_0.9.html)
 
-### Troubleshooting
+## Troubleshooting
 
 It is recommended to use `conda` to install pandas, which is currently a dependency of this package.
 This package interfaces with OpenDSS using the "direct" library interface, so a good understanding of OpenDSS will help troubleshooting.
-There are plenty of useful resources located [here](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Doc/).
 
 If you are having issues using this Python interface, feel free to open an Issue on GitHub [here](https://github.com/dss-extensions/OpenDSSDirect.py/issues/new).
 
-### Thanks
+## Thanks
 
 Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions, as well as all the users for their valuable feedback.