Skip to content

Commit

Permalink
Remove explicit download_mfbinaries in favor of auto download
Browse files Browse the repository at this point in the history
  • Loading branch information
bdestombe committed Jun 24, 2024
1 parent 096ae54 commit 1fca2b7
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 36 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@ jobs:
# exit-zero treats all errors as warnings.
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=80 --statistics
- name: Download executables needed for tests
shell: bash -l {0}
run: |
python -c "import nlmod; nlmod.util.download_mfbinaries()"
- name: Run tests only
env:
NHI_GWO_USERNAME: ${{ secrets.NHI_GWO_USERNAME}}
Expand Down
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,4 @@ notoriously hard to install on certain platforms. Please see the

## Getting started

If you are using `nlmod` for the first time you need to download the MODFLOW
executables. You can easily download these executables by running this Python code:

import nlmod
nlmod.download_mfbinaries()

After you've downloaded the executables you can run the Jupyter Notebooks in the
examples folder. These notebooks illustrate how to use the `nlmod` package.
Start with the Jupyter Notebooks in the examples folder. These notebooks illustrate how to use the `nlmod` package.
19 changes: 0 additions & 19 deletions docs/examples/00_model_from_scratch.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -35,25 +35,6 @@
"nlmod.util.get_color_logger(\"INFO\");"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Download MODFLOW-binaries\n",
"To run MODFLOW, we need to download the MODFLOW-excecutables. We do this with the following code:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"if not nlmod.util.check_presence_mfbinaries():\n",
" nlmod.download_mfbinaries()"
]
},
{
"attachments": {},
"cell_type": "markdown",
Expand Down
6 changes: 2 additions & 4 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,8 @@ MODFLOW 6 model given a model dataset::

# ... add some boundary condition packages (GHB, RIV, DRN, ...)

Running the model requires the modflow binaries provided by the USGS. Those can
be downloaded with::

nlmod.download_mfbinaries()
The MODFLOW 6 executable is automatically downloaded and installed to your system
when building the first model.

Writing and running the model can then be done using::

Expand Down

0 comments on commit 1fca2b7

Please sign in to comment.