rearrange and new api tests (#3)

loriab · web-flow · commit f288313ad73d · 2025-03-12T13:20:50.000-04:00
* rearrange and new api tests

* try 2

* try 3

* try 4

* try 5

* try 7

* try 8

* try 9

* try 10

* try 11

* try 12

* try 13

* try 14

* Add files via upload

* Update README.md

* try 15

* try 12

* try 17

* try 18
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -56,6 +56,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        persist-credentials: false
 
     - name: Install Conda Python ${{ matrix.cfg.python-version }} and power software
       if: matrix.cfg.label == 'conda'
@@ -144,11 +145,11 @@ jobs:
         julia -e 'ENV["PYTHON"]="/Users/runner/hostedtoolcache/Python/3.12.9/x64/bin/python"; using Pkg; Pkg.build("PyCall")'
 
     - name: Special setup download delay
-      if: runner.os == 'macOS'
-      # file download in next section is flaky, esp. for Mac. use `sed -i "s;;;g"` for non-Mac
+      if: false  # runner.os == 'macOS'
+      # file download in (basic) section is flaky for Mac. use `sed -i "s;;;g"` for non-Mac
       run: |
-        sed -E -i.bak "s;nb_retry=10;nb_retry=50;g" $(dirname $(which python))/../lib/python${{ matrix.cfg.python-version }}/site-packages/grid2op/MakeEnv/Make.py
-        sed -E -i.bak "s;time.sleep(1);time.sleep(3);g" $(dirname $(which python))/../lib/python${{ matrix.cfg.python-version }}/site-packages/grid2op/MakeEnv/Make.py
+        sed -E -i.bak "s;nb_retry=10;nb_retry=100;g" $(dirname $(which python))/../lib/python${{ matrix.cfg.python-version }}/site-packages/grid2op/MakeEnv/Make.py
+        sed -E -i.bak "s;time.sleep(1);time.sleep(8);g" $(dirname $(which python))/../lib/python${{ matrix.cfg.python-version }}/site-packages/grid2op/MakeEnv/Make.py
 
     - name: Test PowerModels in PandaPower
       run: |
@@ -158,10 +159,115 @@ jobs:
         # loc is simply $CONDA_PREFIX but the setup-python counterpart env.pythonLocation seems broken
         # PdP testing above has a couple failures b/c Ipopt=1 unless downgrade (taking PM with it)
 
-    - name: Test PandaModelsBackend
-      # if: false  # for now since there's some issues
+    - name: Test PandaModelsBackend (basic)
+      if: runner.os == 'Linux'
       run: |
-        cd tests
         which python python-jl
-        python-jl test_basic_usage.py
-        # python test_backend_api.py
+        python-jl tests/test_basic_usage.py
+
+    - name: Test PandaModelsBackend (API)
+      run: |
+        python-jl tests/test_backend_api.py
+
+    - name: Install pypa/build & build a binary wheel and a source tarball
+      if: matrix.cfg.label == 'installer' && runner.os == 'Linux'
+      run: |
+        python -m pip install build --user
+        python -m build
+
+    - name: Store the distribution packages
+      if: matrix.cfg.label == 'installer' && runner.os != 'macOS'
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pandamodelsbackend
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        "$GITHUB_REF_NAME"
+        --repo "$GITHUB_REPOSITORY"
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        "$GITHUB_REF_NAME" dist/**
+        --repo "$GITHUB_REPOSITORY"
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/pandamodelsbackend
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        verbose: true
diff --git a/README.md b/README.md
@@ -1,13 +1,16 @@
 # PandaModelsBackend
-Provides a high fidelity backend for grid2op that uses PowerModels.jl. It achieves this using pandapower interface that calls PandaModels using PyCall to call julia functions from python.
+
+PandaModelsBackend provides a high-fidelity backend for [Grid2op](https://github.com/Grid2op/grid2op) that uses [PowerModels.jl](https://github.com/lanl-ansi/PowerModels.jl). It achieves this using a [pandapower](https://github.com/e2nIEE/pandapower) interface that calls [PandaModels.jl](https://github.com/e2nIEE/PandaModels.jl) using PyCall to call Julia functions from Python.
+
+<img src="https://github.com/gt-sse-center/PandaModelsBackend/blob/rearr/devtools/power_software_map.png" height=450>
 
 ## Installation
 ```pip install pandamodelsbackend```
 
 ## Refer to [tests/test_basic_usage.py]()
 
 ```
-from PandaModelsBackend import PandaModelsBackend
+from pandamodelsbackend import PandaModelsBackend
 
 pp_net = pp.from_json(network_file)  # Load PandaPower JSON
 .
diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,35 @@
+# Changelog
+
+<!--
+## vX.Y.0 / 2025-MM-DD (Unreleased)
+
+#### Breaking Changes
+
+#### New Features
+
+#### Enhancements
+
+#### Bug Fixes
+
+#### Misc.
+
+-->
+
+
+## v0.1.0 / 2025-MM-DD (Unreleased)
+
+#### Breaking Changes
+
+#### New Features
+ * [\#1] (https://github.com/gt-sse-center/PandaModelsBackend/pull/1) Maint --
+   added CI to show how to set up working environment with and without conda.
+ * [\#2] (https://github.com/gt-sse-center/PandaModelsBackend/pull/2) Main --
+   copied backend from grid2op, made modifications to call PandaPower, checked
+   against AAA backend tests, and excused some until next v0.11 grid2op release.
+
+#### Enhancements
+
+#### Bug Fixes
+
+#### Misc.
+
diff --git a/devtools/power_software_map.png b/devtools/power_software_map.png
diff --git a/pandamodelsbackend/__init__.py b/pandamodelsbackend/__init__.py
@@ -0,0 +1,3 @@
+__all__ = ["PandaModelsBackend"]
+
+from .pandaModelsBackend import PandaModelsBackend
diff --git a/pandamodelsbackend/pandaModelsBackend.py b/pandamodelsbackend/pandaModelsBackend.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,33 +1,58 @@
 [project]
-name = "PandaModelsBackend"
-version = "0.0.1"
-description = "A PowerModels Backend for Grid2Op using PandaModels"
+name = "pandamodelsbackend"
+dynamic = ["version"]
+description = "A PowerModels Backend for Grid2op using PandaModels through PandaPower"
 authors = [
     { name = "Ketan Bhardwaj", email = "ketanbj@gmail.com" }
 ]
 readme = "README.md"
 license = { file = "LICENSE" }
 requires-python = ">=3.12"
+# py312 taken from Donti env; other py versions untested
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "numpy",
+    "scipy",
+    "pandas",
+    "pandapower",
+    # packaging?
+    "grid2op",
+]
 
 [project.urls]
 repository = "https://github.com/gt-sse-center/PandaModelsBackend"
+changelog = "https://github.com/gt-sse-center/PandaModelsBackend/blob/main/changelog.md"
+issues = "https://github.com/gt-sse-center/PandaModelsBackend/issues"
 
 [project.optional-dependencies]
 tests = [
-    "pytest",
     "setuptools",
+    # "pytest",
     # grid2op uses pkg_resources
 ]
+numba = [
+    "numba",
+]
 
 [build-system]
 requires = [
-    "setuptools",
-    "setuptools-scm",
+    "setuptools>=64",
+    "setuptools-scm>=8",
     "wheel",
     "pip"
 ]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+packages = ["pandamodelsbackend"]
+
 [tool.setuptools_scm]
 version_scheme = "guess-next-dev"
 local_scheme = "no-local-version"
diff --git a/src/PandaModelsBackend/__init__.py b/src/PandaModelsBackend/__init__.py
diff --git a/tests/test_backend_api.py b/tests/test_backend_api.py
@@ -1,7 +1,7 @@
 import unittest
 from grid2op.tests.aaa_test_backend_interface import AAATestBackendAPI
 
-from PandaModelsBackend import PandaModelsBackend
+from pandamodelsbackend import PandaModelsBackend
 
 class TestBackendAPI_PandaModelsBackend(AAATestBackendAPI, unittest.TestCase):
     def make_backend(self, detailed_infos_for_cascading_failures=False):
diff --git a/tests/test_basic_usage.py b/tests/test_basic_usage.py
@@ -1,5 +1,5 @@
 import grid2op
-from PandaModelsBackend import PandaModelsBackend
+from pandamodelsbackend import PandaModelsBackend
 import pandapower as pp
 import pandapower.converter as pp_converter
 import os
@@ -77,4 +77,4 @@ def test_grid2op_pandapower():
 
 # Run the test
 if __name__ == "__main__":
-    test_grid2op_pandapower()
+    test_grid2op_pandapower()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+__all__ = ["PandaModelsBackend"]`
	`2`	`+`
	`3`	`+from .pandaModelsBackend import PandaModelsBackend`