Tests

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+name: ci
+on:
+  push:
+  # schedule:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
+    # 5:20 am UTC (11:20pm MDT the day before) every weekday night in MDT
+  #   - cron: '20 5 * * 2-6'
+  # pull_request:
+  #   types: [review_requested]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.8", "3.12"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install ditto-reader
+        run: pip install .[dev]
+      - name: Run pre-commit to confirm linting and formatting
+        # https://github.com/pre-commit/action
+        uses: pre-commit/action@v3.0.0
+        with:
+          extra_args: --all-files
+      - name: Run unit tests
+        run: python -Wonce::DeprecationWarning -Im pytest -vv

.gitignore

@@ -112,6 +112,7 @@ venv.bak/
 
 # IDE settings
 .vscode/
+.ruff_cache
 
 # Spyder project settings
 .spyderproject
@@ -134,8 +135,5 @@ dmypy.json
 # DS_Store
 .DS_Store
 
-# opendss files
-./example/run/baseline_scenario/opendss/
-
 # ditto local checkout
 ditto/

.pre-commit-config.yaml

@@ -1,8 +1,10 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-ast
+      - id: check-added-large-files
+        args: ['--maxkb=2000']
       - id: end-of-file-fixer
       - id: trailing-whitespace
       - id: check-toml
@@ -24,13 +26,13 @@ repos:
       # - id: check-hooks-apply # Fails if a hook doesn't apply to any file
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.0.285
+    rev: v0.1.3
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
         types_or: [python, pyi, jupyter]
   - repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 23.10.1
     hooks:
     - id: black-jupyter
 default_language_version:

README.md

@@ -3,7 +3,7 @@ Enhancement of URBANopt™ GeoJSON that can be consumed by DiTTo reader \
 More detailed documentation is available on the [URBANopt documentation page](https://docs.urbanopt.net/opendss/opendss.html)
 
 # Installation Pre-requisites
-- Python >=3.7
+- Python >=3.8
 - Requires Python 3.10 if using via the URBANopt CLI.
 
 # Installation
@@ -64,15 +64,17 @@ If either start_time and end_time are invalid or set to None, the simulation wil
 - Create & activate your favorite venv in the repo (I prefer pyenv for [mac/linux](https://github.com/pyenv/pyenv#installation) or [windows](https://github.com/pyenv-win/pyenv-win#installation), and the [virtualenv plugin](https://github.com/pyenv/pyenv-virtualenv))
     - Activate pre-commit (only once, after making a new venv): `pre-commit install`
     - Runs automatically on your staged changes before every commit
-- Update pip and setuptools: `pip install -U pip setuptools .`
+- Update pip and setuptools: `pip install -U pip setuptools`
 - Install the respository with developer dependencies: `pip install -e .[dev]`
-- To check all files, run `pre-commit run --all-files`
+- To check the whole repo, run `pre-commit run --all-files`
     - Settings and documentation links for pre-commit and ruff are in .pre-commit-config.yaml and pyproject.toml
 
-## Publish Package
+# Releasing
+Follow the [PyPA guidance](https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives) as of April 2, 2022
 
-- update version in setup.py
+Roughly:
+- update version in pyproject.toml
 - make a release on GitHub
-- make the package: `python setup.py sdist`
+- make the package: `python -m build`
 - install twine `pip install twine`
 - upload to pypi: `twine upload dist/*`

example/run/baseline_scenario/opendss/dss_files/LoadShapes.dss

@@ -1,25 +1,25 @@
-New Loadshape.feature_1 npts= 8759 interval=1.0 mult = (file=..\profiles\load_1_pu.csv)
+New Loadshape.feature_1 npts= 8759 interval=1.0 mult = (file=../profiles/load_1_pu.csv)
 
-New Loadshape.feature_2 npts= 8759 interval=1.0 mult = (file=..\profiles\load_2_pu.csv)
+New Loadshape.feature_2 npts= 8759 interval=1.0 mult = (file=../profiles/load_2_pu.csv)
 
-New Loadshape.feature_3 npts= 8759 interval=1.0 mult = (file=..\profiles\load_3_pu.csv)
+New Loadshape.feature_3 npts= 8759 interval=1.0 mult = (file=../profiles/load_3_pu.csv)
 
-New Loadshape.feature_4 npts= 8759 interval=1.0 mult = (file=..\profiles\load_4_pu.csv)
+New Loadshape.feature_4 npts= 8759 interval=1.0 mult = (file=../profiles/load_4_pu.csv)
 
-New Loadshape.feature_5 npts= 8759 interval=1.0 mult = (file=..\profiles\load_5_pu.csv)
+New Loadshape.feature_5 npts= 8759 interval=1.0 mult = (file=../profiles/load_5_pu.csv)
 
-New Loadshape.feature_6 npts= 8759 interval=1.0 mult = (file=..\profiles\load_6_pu.csv)
+New Loadshape.feature_6 npts= 8759 interval=1.0 mult = (file=../profiles/load_6_pu.csv)
 
-New Loadshape.feature_7 npts= 8759 interval=1.0 mult = (file=..\profiles\load_7_pu.csv)
+New Loadshape.feature_7 npts= 8759 interval=1.0 mult = (file=../profiles/load_7_pu.csv)
 
-New Loadshape.feature_8 npts= 8759 interval=1.0 mult = (file=..\profiles\load_8_pu.csv)
+New Loadshape.feature_8 npts= 8759 interval=1.0 mult = (file=../profiles/load_8_pu.csv)
 
-New Loadshape.feature_9 npts= 8759 interval=1.0 mult = (file=..\profiles\load_9_pu.csv)
+New Loadshape.feature_9 npts= 8759 interval=1.0 mult = (file=../profiles/load_9_pu.csv)
 
-New Loadshape.feature_10 npts= 8759 interval=1.0 mult = (file=..\profiles\load_10_pu.csv)
+New Loadshape.feature_10 npts= 8759 interval=1.0 mult = (file=../profiles/load_10_pu.csv)
 
-New Loadshape.feature_11 npts= 8759 interval=1.0 mult = (file=..\profiles\load_11_pu.csv)
+New Loadshape.feature_11 npts= 8759 interval=1.0 mult = (file=../profiles/load_11_pu.csv)
 
-New Loadshape.feature_12 npts= 8759 interval=1.0 mult = (file=..\profiles\load_12_pu.csv)
+New Loadshape.feature_12 npts= 8759 interval=1.0 mult = (file=../profiles/load_12_pu.csv)
 
-New Loadshape.feature_13 npts= 8759 interval=1.0 mult = (file=..\profiles\load_13_pu.csv)
+New Loadshape.feature_13 npts= 8759 interval=1.0 mult = (file=../profiles/load_13_pu.csv)

example/run/baseline_scenario/opendss/dss_files/Loads.dss

@@ -1,6 +1,6 @@
 New Load.1 bus1=e4bcf9d6-e0b7-421c-91d4-554d06c69364.1.2.3 kV=12.47 model=1 kW=4961.147721461635 kvar=1138.1653453593858 Phases=3 yearly=feature_1
 
-New Load.2 bus1=53c917d8-b04d-4110-bdd9-cbf044e6a1fa.1.2.3 kV=0.48 model=1 kW=226.26934267290764 kvar=51.909747301714695 Phases=3 yearly=feature_2
+New Load.2 bus1=53c917d8-b04d-4110-bdd9-cbf044e6a1fa.1.2.3 kV=0.48 model=1 kW=226.26934267290758 kvar=51.90974730171469 Phases=3 yearly=feature_2
 
 New Load.3 bus1=67b07fac-6666-4954-98b8-3e08b0896646.1.2.3 kV=12.47 model=1 kW=1277.8064698880355 kvar=293.1489090339154 Phases=3 yearly=feature_3
 
@@ -10,7 +10,7 @@ New Load.5 bus1=3d1aa47d-69dd-4200-ab34-9b6244ad82d7.1.2.3 kV=0.48 model=1 kW=12
 
 New Load.6 bus1=db52eea7-f395-4fb1-999d-47c82333a4a7.1.2.3 kV=0.48 model=1 kW=15.74178000285817 kvar=3.6114120117846387 Phases=3 yearly=feature_6
 
-New Load.7 bus1=9d037967-7ac1-4296-8f87-2d4a842d7a87.1.2.3 kV=0.48 model=1 kW=1010.9459946369252 kvar=231.9269172631351 Phases=3 yearly=feature_7
+New Load.7 bus1=9d037967-7ac1-4296-8f87-2d4a842d7a87.1.2.3 kV=0.48 model=1 kW=1010.9459946369254 kvar=231.92691726313512 Phases=3 yearly=feature_7
 
 New Load.8 bus1=18fe5a25-2547-4c32-a225-8bd455e93c9b.1.2.3 kV=12.47 model=1 kW=2185.323191585642 kvar=501.347523741978 Phases=3 yearly=feature_8