refactor: remove executables module/class (#136)

* unused by any consuming projects * of questionable utility, just use dict
MODFLOW-USGS · Jan 25, 2024 · 9356e06 · 9356e06
1 parent a9b8019
commit 9356e06
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 107 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -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

diff --git a/autotest/test_executables.py b/autotest/test_executables.py
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,6 @@ The `modflow-devtools` package provides a set of tools for developing and testin
    :maxdepth: 2
    :caption: Test fixtures
 
-   md/executables.md
    md/fixtures.md
    md/markers.md
 

diff --git a/docs/md/executables.md b/docs/md/executables.md
diff --git a/docs/md/fixtures.md b/docs/md/fixtures.md
@@ -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
 

diff --git a/docs/md/install.md b/docs/md/install.md
@@ -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 &mdash; to run the models too, omit `--init`.
diff --git a/modflow_devtools/executables.py b/modflow_devtools/executables.py