Update docs (#133)

* Update docs * Update lock file
Deltares · Apr 19, 2024 · cce538f · cce538f
1 parent 513c3db
commit cce538f
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 26 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -30,7 +30,7 @@ jobs:
         with:
           manifest-path: pyproject.toml
       - name: Test with pytest
-        run: pixi run test-ci
+        run: pixi run tests-ci
         env: 
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload coverage to Codecov

diff --git a/README.md b/README.md
@@ -7,15 +7,15 @@
 `xmipy` is an extension to [bmipy](https://pypi.org/project/bmipy/) including an implementation of the abstract methods.
 The extended interface is required to couple certain hydrological kernels, particularly MODFLOW 6. Currently it is a joint development of the USGS and Deltares. The [imod_coupler](https://github.com/Deltares/imod_coupler) uses it, for example, to couple MODFLOW 6 and MetaSWAP.
 
-`xmipy` can be installed by running
-```
-pip install xmipy
-```
+`xmipy` can be downloaded from [conda-forge](https://anaconda.org/conda-forge/xmipy) or [PyPI](https://pypi.org/project/xmipy/).
 
 # Contributing
 
-In order to develop on `xmipy` locally, execute the following line inside your virtual environment
+In order to develop on `xmipy`, you have to download pixi.
+Pixi can be downloaded at [pixi.sh](https://pixi.sh/latest/).
+
+In order to run the test suite, execute:
 
 ```bash
-pip install -e ".[tests, lint, docs]"
+pixi run tests
 ```
diff --git a/pixi.lock b/pixi.lock
@@ -2591,8 +2591,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/cb/95/4a02a0fed559bf638001f6bf4e4c9d685111db959d221485e7e27c91e954/black-24.4.0-cp311-cp311-macosx_10_9_x86_64.whl
-  sha256: 8e5537f456a22cf5cfcb2707803431d2feeb82ab3748ade280d6ccd0b40ed2e8
+  url: https://files.pythonhosted.org/packages/97/a6/f5857f79bba7eca05ebdc7e27e3447e3d2fc23898bb04f34bf3ff5dfb2db/black-24.4.0-cp311-cp311-macosx_11_0_arm64.whl
+  sha256: 64e60a7edd71fd542a10a9643bf369bfd2644de95ec71e86790b063aa02ff745
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2631,8 +2631,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/97/a6/f5857f79bba7eca05ebdc7e27e3447e3d2fc23898bb04f34bf3ff5dfb2db/black-24.4.0-cp311-cp311-macosx_11_0_arm64.whl
-  sha256: 64e60a7edd71fd542a10a9643bf369bfd2644de95ec71e86790b063aa02ff745
+  url: https://files.pythonhosted.org/packages/cb/95/4a02a0fed559bf638001f6bf4e4c9d685111db959d221485e7e27c91e954/black-24.4.0-cp311-cp311-macosx_10_9_x86_64.whl
+  sha256: 8e5537f456a22cf5cfcb2707803431d2feeb82ab3748ade280d6ccd0b40ed2e8
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2691,8 +2691,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/99/f7/bd2b367aa8833d532451d943ecc0deb7f846f872477bfa8deaa04e86373b/black-24.4.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
-  sha256: dae79397f367ac8d7adb6c779813328f6d690943f64b32983e896bcccd18cbad
+  url: https://files.pythonhosted.org/packages/d5/41/9c3d8ec509cfb35b646c00cb912d769f9a92aa5e469401d90b80314d209f/black-24.4.0-cp310-cp310-win_amd64.whl
+  sha256: 71d998b73c957444fb7c52096c3843875f4b6b47a54972598741fe9a7f737fcb
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2711,8 +2711,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/d5/41/9c3d8ec509cfb35b646c00cb912d769f9a92aa5e469401d90b80314d209f/black-24.4.0-cp310-cp310-win_amd64.whl
-  sha256: 71d998b73c957444fb7c52096c3843875f4b6b47a54972598741fe9a7f737fcb
+  url: https://files.pythonhosted.org/packages/99/f7/bd2b367aa8833d532451d943ecc0deb7f846f872477bfa8deaa04e86373b/black-24.4.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+  sha256: dae79397f367ac8d7adb6c779813328f6d690943f64b32983e896bcccd18cbad
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2731,8 +2731,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/ef/32/5e59d4aeec3db4964404939ae7d3d9e839df7c882cd50296f3cfcb4738c5/black-24.4.0-cp39-cp39-win_amd64.whl
-  sha256: 7852b05d02b5b9a8c893ab95863ef8986e4dda29af80bbbda94d7aee1abf8702
+  url: https://files.pythonhosted.org/packages/a3/bb/b1054dce88a6405329890a9006b355eb133845da8dcc62e6c88f9a55435b/black-24.4.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+  sha256: eb949f56a63c5e134dfdca12091e98ffb5fd446293ebae123d10fc1abad00b9e
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2751,8 +2751,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/a3/bb/b1054dce88a6405329890a9006b355eb133845da8dcc62e6c88f9a55435b/black-24.4.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
-  sha256: eb949f56a63c5e134dfdca12091e98ffb5fd446293ebae123d10fc1abad00b9e
+  url: https://files.pythonhosted.org/packages/42/c6/1fe1d87c212a91164c7ab35e98350167667da039ce5f92552c7c3e36d0df/black-24.4.0-cp39-cp39-macosx_11_0_arm64.whl
+  sha256: 75a2d0b4f5eb81f7eebc31f788f9830a6ce10a68c91fbe0fade34fff7a2836e6
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2771,8 +2771,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/42/c6/1fe1d87c212a91164c7ab35e98350167667da039ce5f92552c7c3e36d0df/black-24.4.0-cp39-cp39-macosx_11_0_arm64.whl
-  sha256: 75a2d0b4f5eb81f7eebc31f788f9830a6ce10a68c91fbe0fade34fff7a2836e6
+  url: https://files.pythonhosted.org/packages/6c/b0/6dd1ad928d28b52d8f931e94ad94f5ac302dca984cc5aefa616143d8ebdb/black-24.4.0-cp39-cp39-macosx_10_9_x86_64.whl
+  sha256: 6644f97a7ef6f401a150cca551a1ff97e03c25d8519ee0bbc9b0058772882665
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -2791,8 +2791,8 @@ packages:
 - kind: pypi
   name: black
   version: 24.4.0
-  url: https://files.pythonhosted.org/packages/6c/b0/6dd1ad928d28b52d8f931e94ad94f5ac302dca984cc5aefa616143d8ebdb/black-24.4.0-cp39-cp39-macosx_10_9_x86_64.whl
-  sha256: 6644f97a7ef6f401a150cca551a1ff97e03c25d8519ee0bbc9b0058772882665
+  url: https://files.pythonhosted.org/packages/ef/32/5e59d4aeec3db4964404939ae7d3d9e839df7c882cd50296f3cfcb4738c5/black-24.4.0-cp39-cp39-win_amd64.whl
+  sha256: 7852b05d02b5b9a8c893ab95863ef8986e4dda29af80bbbda94d7aee1abf8702
   requires_dist:
   - click >=8.0.0
   - mypy-extensions >=0.4.3
@@ -12917,7 +12917,7 @@ packages:
   name: xmipy
   version: 1.4.0
   path: .
-  sha256: ea9e6d9742270ad72d2510320cb3bd91e168acf648183288533f64ec28be7a2c
+  sha256: 22661204755a002fd526e07e51b5d1d50a2bb79a87269923bfe36e56df8653b3
   requires_dist:
   - bmipy
   - numpy

diff --git a/pyproject.toml b/pyproject.toml
@@ -56,8 +56,8 @@ twine = "*"
 # Tests
 # The flag -s stops pytest from capturing output
 # This is necessary until proper error reporting is implemented by Modflow
-test-ci = "pytest -vs --cov=xmipy --cov-report=xml tests/"
-test = "pytest tests"
+tests-ci = "pytest -vs --cov=xmipy --cov-report=xml tests/"
+tests = "pytest tests/"
 
 # Docs
 docs = "pdoc -o docs/ xmipy"