From 1fca2b7bda58eed0b144f2f88c734fa16ddc6f4a Mon Sep 17 00:00:00 2001 From: Bas des Tombe Date: Mon, 24 Jun 2024 15:29:59 +0200 Subject: [PATCH] Remove explicit download_mfbinaries in favor of auto download --- .github/workflows/ci.yml | 5 ----- README.md | 9 +-------- docs/examples/00_model_from_scratch.ipynb | 19 ------------------- docs/getting_started.rst | 6 ++---- 4 files changed, 3 insertions(+), 36 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 60c27dae..9c2b3fdf 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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}} diff --git a/README.md b/README.md index 1bfec90f..0286b4d9 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/examples/00_model_from_scratch.ipynb b/docs/examples/00_model_from_scratch.ipynb index 40579e4f..3163a444 100644 --- a/docs/examples/00_model_from_scratch.ipynb +++ b/docs/examples/00_model_from_scratch.ipynb @@ -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", diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 4d995c5c..378af872 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -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::