Self-contained example notebooks

[wpbonelli]

Background

The MODFLOW 6 example problems are an entry point to MODFLOW and a common first step is likely to locally reproduce example problems, but the notebooks assumes the common/](https://github.com/MODFLOW-USGS/modflow6-examples/tree/master/common) and data directories are present in the right relative locations, used from notebooks via sys.path manipulation. So it is either necessary to clone the repo then running the scripts or notebooks from the scripts/ or notebooks/ folders, respectively, manually download the implicit dependencies, or alter the examples to remove them.

Proposal

The example notebooks could be downloadable from the docs, and could run with no external dependencies besides a Python/flopy environment and the MODFLOW binaries.

• update RTD site site: render thumbnail gallery of downloadable notebooks on ReadTheDocs like flopy, fix order of example descriptions and notebooks to match each other
• remove .ipynb files from version control or stripping output/metadata before committing
  • docs: remove ipynb files from version control modflow6-examples#128
• move general-purpose utilities from the mf6 examples repo's common/ to modflow-devtools — if a modeling-related utility is only used from a single notebook, moving it into that notebook — if a modeling-related utility is used from multiple notebooks, or may be more broadly useful, moving it to flopy — make mf6 notebooks self-contained and immediately runnable, without cloning the repo, copying files, etc
  • feat: add latex and plot style utilities modflow-devtools#132
  • refactor: self-contained example scripts modflow6-examples#137

Related: make flopy notebooks self-contained

[wpbonelli]

if MODFLOW-USGS/modflow-devtools#134 materializes example scripts can be updated to use it, but otherwise this is done — the examples now only require modflow programs and a suitable python environment, no implicit filesystem dependencies