chore(pixi): use custom install task for internal dev dependencies (#…

…1728) Restore the custom task approach to installing flopy, modflowapi, pymake, and modflow-devtools originally introduced by @Hofer-Julian in #1696. This unlocks them (removes them from pixi.lock) and allows rolling updates in CI, as we had before #1703. Going forward, contributors will need to run `pixi run install` instead of `pixi install` to get a full development environment. Also remove hatchling from pixi.toml as it is not needed.
MODFLOW-USGS · Apr 17, 2024 · 1d6e6b1 · 1d6e6b1
1 parent 94ba5b9
commit 1d6e6b1
Show file tree

Hide file tree

Showing 8 changed files with 231 additions and 694 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -129,6 +129,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Build test-drive
         working-directory: test-drive
         run: |
@@ -224,6 +228,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Set LDFLAGS (macOS)
         if: matrix.os == 'macos-14'
         run: |
@@ -346,6 +354,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Setup ${{ env.FC }} ${{ env.FC_V }}
         uses: fortran-lang/setup-fortran@v1
         with:
@@ -433,6 +445,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Test parallel MF6
         if: runner.os != 'Windows'
         uses: ./modflow6/.github/actions/test-par

diff --git a/.github/workflows/compilers.yml b/.github/workflows/compilers.yml
@@ -143,6 +143,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Build modflow6
         working-directory: modflow6
         run: |

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -47,6 +47,10 @@ jobs:
         with:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
+
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
 
       - name: Install additional packages for Sphinx using pip
         working-directory: modflow6/.build_rtd_docs
@@ -198,6 +202,9 @@ jobs:
         with:
           pixi-version: v0.19.1
 
+      - name: Custom pixi install
+        run: pixi run install
+
       - name: Print python package versions
         run: pixi run pip list
 

diff --git a/.github/workflows/large.yml b/.github/workflows/large.yml
@@ -72,6 +72,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Setup ${{ matrix.compiler }} ${{ matrix.version }}
         uses: fortran-lang/setup-fortran@v1
         with:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -104,6 +104,10 @@ jobs:
           pixi-version: v0.19.1
           manifest-path: "modflow6/pixi.toml"
 
+      - name: Custom pixi install
+        working-directory: modflow6
+        run: pixi run install
+
       - name: Setup Micromamba
         uses: mamba-org/setup-micromamba@v1
         with:

diff --git a/DEVELOPER.md b/DEVELOPER.md
@@ -182,7 +182,7 @@ The following tables are automatically generated by [a CI workflow](.github/work
 Python 3.8+ is required to run MODFLOW 6 tests. Using Python via Pixi is recommended. Pixi installation docs can be found [here](https://pixi.sh). After installing `pixi`, to set up an environment with all development dependencies, run:
 
 ```
-pixi install
+pixi run install
 ```
 
 #### Dependencies

diff --git a/pixi.lock b/pixi.lock
diff --git a/pixi.toml b/pixi.toml
@@ -10,11 +10,9 @@ filelock = "*"
 flaky = "*"
 fortran-language-server = "*"
 fprettify = "*"
-hatchling = "*"
 jupytext = "*"
 matplotlib = "*"
 meson = "1.3.0"
-mfpymake = "*"
 networkx = "*"
 ninja = "*"
 numpy = "*"
@@ -33,12 +31,19 @@ scipy = "*"
 shapely = "*"
 xmipy = "*"
 
-[pypi-dependencies]
-flopy = { git = "https://github.com/modflowpy/flopy.git" }
-modflowapi = { git = "https://github.com/MODFLOW-USGS/modflowapi.git" }
-modflow-devtools = { git = "https://github.com/MODFLOW-USGS/modflow-devtools.git" }
-
 [tasks]
+# install
+install-flopy = "pip install --no-build-isolation --no-deps --disable-pip-version-check git+https://github.com/modflowpy/flopy.git"
+install-pymake = "pip install --no-build-isolation --no-deps --disable-pip-version-check git+https://github.com/modflowpy/pymake.git"
+install-modflowapi = "pip install --no-build-isolation --no-deps --disable-pip-version-check git+https://github.com/MODFLOW-USGS/modflowapi.git"
+install-modflow-devtools = "pip install --no-build-isolation --no-deps --disable-pip-version-check git+https://github.com/MODFLOW-USGS/modflow-devtools.git"
+install = { depends_on = [
+    "install-flopy",
+    "install-pymake",
+    "install-modflowapi",
+    "install-modflow-devtools",
+] }
+
 # format
 fortran-format-check = "python .github/common/fortran_format_check.py"
 msvs-vfproj-check = "python .github/common/msvs_vfproj_check.py"