Skip to content

Commit

Permalink
update examples installation docs/CI
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli committed Jan 25, 2024
1 parent fb766d3 commit 8eecab2
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ jobs:
- name: Build modflow6 example models
if: steps.cache-examples.outputs.cache-hit != 'true'
working-directory: modflow6-examples/etc
run: python ci_build_files.py
working-directory: modflow6-examples/autotest
run: pytest -v -n auto test_scripts.py --init

- name: Run local tests
working-directory: modflow-devtools/autotest
Expand Down
2 changes: 1 addition & 1 deletion docs/md/fixtures.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def test_example_scenario(tmp_path, example_scenario):
# ...
```

**Note**: example models must first be built by running the `ci_build_files.py` script in `modflow6-examples/etc` before running tests using the `example_scenario` fixture. See the [install docs](https://modflow-devtools.readthedocs.io/en/latest/md/install.html) for more info.
**Note**: example models must first be built by running `pytest -v -n auto test_scripts.py --init` in `modflow6-examples/autotest` before running tests using the `example_scenario` fixture. See the [install docs](https://modflow-devtools.readthedocs.io/en/latest/md/install.html) for more info.

### Filtering

Expand Down
6 changes: 3 additions & 3 deletions docs/md/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ cd modflow6-examples/etc
pip install -r requirements.pip.txt
```

Then, still from the `etc` folder, run:
Then, from the `autotest` folder, run:

```shell
python ci_build_files.py
pytest -v -n auto test_scripts.py --init
```

This will build the examples for subsequent use by the tests.
This will build the examples for subsequent use by the tests. To save time, models will not be run — to run the models too, omit `--init`.

0 comments on commit 8eecab2

Please sign in to comment.