install script (#6)

* install script

* commit sha

* if/else

* one version

* trivia

* try script lane

* try 2

* try 3

* try 4

* try 5

* try 6

* try 7

* try 8

* try 9

* try 11

* try 12

* try 13

* try 14

* try 15

* try 16

* try 17

* script for rel, ci for repo

* fix

* fix

* fix

* checkpoint tag

Author: loriab

.github/workflows/ci.yml

@@ -47,6 +47,13 @@ jobs:
             # runs-on: macos-latest  # fails b/c cbc can't compile on M1 (the GHA runners)
             shell: 'bash -e {0}'
 
+          - conda-env: null
+            python-version: "3.12"
+            julia-version: "1.10"
+            label: script
+            runs-on: ubuntu-latest
+            shell: 'bash -l {0}'
+
     defaults:
       run:
         shell: ${{ matrix.cfg.shell }}
@@ -56,16 +63,55 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      if: matrix.cfg.label == 'script'
+      with:
+        sparse-checkout: |
+          devtools/linux_conda_install.sh
+          devtools/conda-envs/unix.yaml
+          # last can be removed
+        sparse-checkout-cone-mode: false
+
+    - uses: actions/checkout@v4
+      if: matrix.cfg.label != 'script'
       with:
         fetch-depth: 0
         persist-credentials: false
 
+    - name: Edit env file
+      if: matrix.cfg.label == 'conda'
+      run: |
+        echo "::group::View Env Spec File for Conda (from repo)"
+        cp devtools/conda-envs/${{ matrix.cfg.conda-env }}.yaml unix.yaml
+        cat unix.yaml
+        echo "::endgroup::"
+        if [[ "${{ runner.os }}" == "Linux" ]]; then
+          :
+          sed -i "s;- pandamodelsbackend;#- pandamodelsbackend;g" unix.yaml
+        fi
+        if [[ "${{ runner.os }}" == "macOS" ]]; then
+          :
+          sed -E -i.bak "s;- pandamodelsbackend;#- pandamodelsbackend;g" unix.yaml
+        fi
+        echo "::group::View Env Spec File for Conda (Edited)"
+        cat unix.yaml
+        echo "::endgroup::"
+        pwd
+        ls -l
+
+    - name: Install Conda Python ${{ matrix.cfg.python-version }}
+      if: matrix.cfg.label == 'script'
+      uses: conda-incubator/setup-miniconda@v3
+      with:
+        show-channel-urls: true
+        auto-activate-base: true
+        activate-environment: ""
+
     - name: Install Conda Python ${{ matrix.cfg.python-version }} and power software
       if: matrix.cfg.label == 'conda'
       uses: conda-incubator/setup-miniconda@v3
       with:
         activate-environment: test
-        environment-file: devtools/conda-envs/${{ matrix.cfg.conda-env }}.yaml
+        environment-file: unix.yaml
         python-version: ${{ matrix.cfg.python-version }}
         auto-activate-base: false
         show-channel-urls: true
@@ -100,6 +146,7 @@ jobs:
         cache-packages: false
 
     - name: Install Julia power software
+      if: matrix.cfg.label != 'script'
       run: |
         julia -e '
             using Pkg
@@ -111,10 +158,12 @@ jobs:
             ])'
 
     - name: Install PandaModelsBackend
+      if: matrix.cfg.label != 'script'
       run: |
         python -m pip install -e .[tests]
 
     - name: Environment information
+      if: matrix.cfg.label != 'script'
       run: |
         python -m pip list
         python -m pip list | grep -e power -e grid -e panda
@@ -124,14 +173,21 @@ jobs:
         julia --version
         julia -e 'using Pkg; Pkg.status(); Pkg.status(outdated=true)'
 
+    - name: Check all-in-one install script
+      if: matrix.cfg.label == 'script'
+      run: |
+        source devtools/linux_conda_install.sh
+
     - name: Test PowerModels in Julia
       # if: false
+      if: matrix.cfg.label != 'script'
       run: |
         julia -e 'using PyCall; math = pyimport("math"); print(math.sin(math.pi/4))'
         julia -e 'using Pkg; Pkg.test("PowerModels")'
         # PM testing above is clean but takes 6m, so optionally toggle off
 
     - name: Test PandaModels in Julia
+      if: matrix.cfg.label != 'script'
       run: |
         julia -e 'using Pkg; Pkg.add(Pkg.PackageSpec(;name="Ipopt", version="0.9"))'
         julia -e 'using Pkg; Pkg.status(); Pkg.status(outdated=true)'
@@ -154,6 +210,7 @@ jobs:
         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
+      if: matrix.cfg.label != 'script'
       run: |
         which python python-jl
         python-jl -m pytest -v $(dirname $(which python))/../lib/python${{ matrix.cfg.python-version }}/site-packages/pandapower/test/opf/test_pandamodels_runpm.py
@@ -162,14 +219,15 @@ jobs:
         # PdP testing above has a couple failures b/c Ipopt=1 unless downgrade (taking PM with it)
 
     - name: Test PandaModelsBackend (basic)
-      if: runner.os == 'Linux'
+      if: runner.os == 'Linux' && matrix.cfg.label != 'script'
       run: |
         which python python-jl
-        python-jl tests/test_basic_usage.py
+        python-jl pandamodelsbackend/tests/test_basic_usage.py
 
     - name: Test PandaModelsBackend (API)
+      if: matrix.cfg.label != 'script'
       run: |
-        python-jl tests/test_backend_api.py
+        python-jl pandamodelsbackend/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'

README.md

@@ -8,7 +8,7 @@ PandaModelsBackend provides a high-fidelity backend for [Grid2op](https://github
 
 ```pip install pandamodelsbackend```
 
-Refer to [test_basic_usage](tests/test_basic_usage.py) for full independently runable example.
+Refer to [test_basic_usage](pandamodelsbackend/tests/test_basic_usage.py) for full independently runable example.
 
 ```
 import grid2op
@@ -31,15 +31,15 @@ Both are shown below and are demonstrated (sort-of, for installers) in [GitHub A
 You'll need to separately install certain dependencies into Python and others into Julia. You never need to enter the Julia REPL.
 If you get tangled up, the CI file is a good, proven route to consult.
 [Docs at pandapower](https://pandapower.readthedocs.io/en/v2.6.0/opf/powermodels.html) may also be helpful.
-There are a lot of acceptable ways to get Python+Julia working, so as long as [`python-jl tests/test_backend_api.py`](tests/test_backend_api.py) is working at the end, you're probably good to run grid2op.
+There are a lot of acceptable ways to get Python+Julia working, so as long as [`python-jl pandamodelsbackend/tests/test_backend_api.py`](pandamodelsbackend/tests/test_backend_api.py) is working at the end, you're probably good to run grid2op.
 
 ##### Notes
 
 * This software stack won't work on M1 Macs.
 * Conda can be used for Python and Julia for Linux and Intel Macs. There isn't a `julia` package for Silicon Macs, so you'll need to use the Julia installer (+ conda or installer Python).
 * A few problems and solutions have been collected [here](#troubleshooting-the-software-stack).
 
-#### Using a Python virtual environment
+### Using a Python virtual environment
 
 - Create a python virtual environment
 ```python3 -m venv venv```
@@ -72,56 +72,13 @@ There are a lot of acceptable ways to get Python+Julia working, so as long as [`
 
      Access the package manager again in julia by typing ]. Now install the packages: ```add PyCall```. To pass the python environment variable, running build PyCall inside the julia package manager may be necessary.
 
-#### Using Conda
+### Using Conda
 
-0. copy a conda env spec file like [unix.yaml](devtools/conda-envs/unix.yaml). Customize python version, environment name, etc.
-
-```
-# 1. create a new conda env from the spec.
-conda env create -f unix.yaml && conda activate test
+A Linux install script is provided at [linux_conda_install.sh](devtools/linux_conda_install.sh) using Conda for Python and Julia dependencies. A *snapshot* (not necessarily latest) is shown below.
 
-# 2. install editable PandaModelsBackend
-git clone https://github.com/gt-sse-center/PandaModelsBackend.git && cd PandaModelsBackend
-pip install -e .
+0. copy a conda env spec file like [unix.yaml](devtools/conda-envs/unix.yaml). Customize python version, environment name, etc.
 
-# 3. install PowerModels into Julia
-#    equivalent to entering pkg mode of Julia REPL, adding packages, and exiting REPL via:
-#    julia <Enter> ] <Enter> add Ipopt PowerModels PyCall <Enter> # await compilation <Ctrl-D>
-julia -e 'using Pkg; Pkg.add(["Ipopt", "PowerModels", "PandaModels", "PyCall"])'
-
-# 4. (optional) check languages and power projects installed. $CONDA_PREFIX is placeholder, not literal
-which python julia python-jl
-#> $CONDA_PREFIX/bin/python
-#> $CONDA_PREFIX/bin/julia
-#> $CONDA_PREFIX/bin/python-jl
-
-conda list | grep -e power -e grid -e panda
-#>grid2op                   1.10.5.post1             pypi_0    pypi
-#>pandamodelsbackend        0.1.1                    pypi_0    pypi
-#>pandapower                2.14.9             pyhd8ed1ab_1    conda-forge
-#>pandas                    2.2.3           py312hf9745cd_1    conda-forge
-
-# equivalent to `julia <Enter> ] <Enter> status <Enter> # observe <Ctrl-D>
-julia -e 'using Pkg; Pkg.status(); Pkg.status(outdated=true)'
-#>Status `$CONDA_PREFIX/share/julia/environments/test/Project.toml`
-#>⌅ [b6b21f68] Ipopt v0.9.1
-#>  [2dbab86a] PandaModels v0.7.3
-#>⌅ [c36e90e8] PowerModels v0.19.10
-#>  [438e738f] PyCall v1.96.4
-#>Status `$CONDA_PREFIX/share/julia/environments/test/Project.toml`
-#>⌅ [b6b21f68] Ipopt v0.9.1 (<v1.7.2): PandaModels
-#>⌅ [c36e90e8] PowerModels v0.19.10 (<v0.21.3): PandaModels
-
-# 5. (optional) check Python, Julia, PandaPower functioning together
-julia -e 'using PyCall; math = pyimport("math"); print(math.sin(math.pi/4))'
-#>0.7071067811865475
-pyMm=$(python -c "import sys;print(f'{sys.version_info.major}.{sys.version_info.minor}')")
-python-jl $CONDA_PREFIX/lib/python$pyMm/site-packages/pandapower/test/opf/test_pandamodels_runpm.py
-#>20 passed, 1 xpassed, 1226 warnings in 267.01s (0:04:27)
-python-jl tests/test_backend_api.py
-#>Ran 31 tests in 58.499s
-#>OK
-```
+https://github.com/gt-sse-center/PandaModelsBackend/blob/d13dcd6fd43edecb3819562ec11398aa576d71e7/devtools/linux_conda_install.sh#L16-L58
 
 -----
 
@@ -135,7 +92,7 @@ pip install -e .
 
 ## Test
 ```
-cd tests
+cd pandamodelsbackend/tests
 python test_backend_api.py
 # depending on installation, `python-jl` may be needed instead of `python` above
 ```

changelog.md

@@ -29,6 +29,13 @@
 #### Misc.
 
 
+## v0.1.4 / 2025-03-24
+
+#### New Features
+ * [\#6] (https://github.com/gt-sse-center/PandaModelsBackend/pull/6) Maint --
+   added installer script, part I.
+
+
 ## v0.1.3 / 2025-03-17
 
 #### New Features

devtools/conda-envs/unix.yaml

@@ -16,11 +16,12 @@ dependencies:
   - setuptools
   - pip
   - pip:
+    - pandamodelsbackend  # this repo. comment this, clone the repo, and `pip install -e .` to develop
     - grid2op
   # - lightsim2grid  # optional
   # - matpowercaseframes  # optional
   # - cxx-compiler  # optional if needed for further pip packages requiring compilation
 
 # Notes:
-# * py312 has been tested. others likely work
+# * py312 has been tested. others likely work. py313 may be blocked by requiring numpy v1
 # * works as-is for Linux and Intel Mac. conda packages for Julia aren't available for Silicon Mac.

devtools/conda-envs/unix_rl2grid.yaml

@@ -18,6 +18,7 @@ dependencies:
   - curl<8.10  # avoid segfault in Julia w/ curl v8.10 . recheck periodically
   - pip
   - pip:
+    - pandamodelsbackend  # this repo. comment this, clone the repo, and `pip install -e .` to develop
     - grid2op
     - lightsim2grid  # optional
     - matpowercaseframes  # optional

devtools/linux_conda_install.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This assumes you do have Miniconda/Anaconda installed.
+# It *doesn't* assume you have Julia installed and instead downloads Julia from Conda.
+# It *doesn't* assume you've cloned the PandaModelsBackend and instead installs latest release. Change at step # 2.
+
+# 0. copy a conda env spec file like [unix.yaml](https://github.com/gt-sse-center/PandaModelsBackend/blob/main/devtools/conda-envs/unix.yaml).
+#   This uses a wget or curl command like the below if not running this script from a repository clone.
+#   Customize python version, environment name, etc.
+if [ -f "./devtools/conda-envs/unix.yaml" ]; then
+    cp -p ./devtools/conda-envs/unix.yaml .
+else
+    curl -o ./unix.yaml https://raw.githubusercontent.com/gt-sse-center/PandaModelsBackend/refs/heads/main/devtools/conda-envs/unix.yaml
+    # wget -O ./unix.yaml https://raw.githubusercontent.com/gt-sse-center/PandaModelsBackend/refs/heads/main/devtools/conda-envs/unix.yaml
+fi
+
+# 1. create a new conda env from the spec.
+cat unix.yaml  # TODO RM
+conda env create -f ./unix.yaml && conda activate test
+
+# 2. install editable PandaModelsBackend
+#git clone https://github.com/gt-sse-center/PandaModelsBackend.git && cd PandaModelsBackend
+#pip install -e .
+
+# 3. install PowerModels into Julia
+#    equivalent to entering pkg mode of Julia REPL, adding packages, and exiting REPL via:
+#    julia <Enter> ] <Enter> add Ipopt PowerModels PyCall <Enter> # await compilation <Ctrl-D>
+julia -e 'using Pkg; Pkg.add(["Ipopt", "PowerModels", "PandaModels", "PyCall"])'
+
+# 4. (optional) check languages and power projects installed. $CONDA_PREFIX is placeholder, not literal
+which python julia python-jl
+#> $CONDA_PREFIX/bin/python
+#> $CONDA_PREFIX/bin/julia
+#> $CONDA_PREFIX/bin/python-jl
+
+conda list | grep -e power -e grid -e panda
+#>grid2op                   1.10.5.post1             pypi_0    pypi
+#>pandamodelsbackend        0.1.1                    pypi_0    pypi
+#>pandapower                2.14.9             pyhd8ed1ab_1    conda-forge
+#>pandas                    2.2.3           py312hf9745cd_1    conda-forge
+
+julia -e 'using Pkg; Pkg.status(); Pkg.status(outdated=true)'
+#>Status `$CONDA_PREFIX/share/julia/environments/test/Project.toml`
+#>⌅ [b6b21f68] Ipopt v0.9.1
+#>  [2dbab86a] PandaModels v0.7.3
+#>⌅ [c36e90e8] PowerModels v0.19.10
+#>  [438e738f] PyCall v1.96.4
+#>Status `$CONDA_PREFIX/share/julia/environments/test/Project.toml`
+#>⌅ [b6b21f68] Ipopt v0.9.1 (<v1.7.2): PandaModels
+#>⌅ [c36e90e8] PowerModels v0.19.10 (<v0.21.3): PandaModels
+
+# 5. (optional) check Python, Julia, PandaPower functioning together
+julia -e 'using PyCall; math = pyimport("math"); print(math.sin(math.pi/4))'
+#>0.7071067811865475
+pyMm=$(python -c "import sys;print(f'{sys.version_info.major}.{sys.version_info.minor}')")
+python-jl $CONDA_PREFIX/lib/python$pyMm/site-packages/pandapower/test/opf/test_pandamodels_runpm.py
+#>20 passed, 1 xpassed, 1226 warnings in 267.01s (0:04:27)
+ls -l $CONDA_PREFIX/lib/python$pyMm/site-packages/pandamodelsbackend/  # TODO RM
+#python-jl pandamodelsbackend/tests/test_backend_api.py  # TODO REENABLE
+#>Ran 31 tests in 58.499s
+#>OK
+