diff --git a/README.md b/README.md index af00aaceef..0bacb6d9c2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Build Status](https://travis-ci.org/modflowpy/flopy.svg?branch=develop)](https://travis-ci.org/modflowpy/flopy) [![PyPI Version](https://img.shields.io/pypi/v/flopy.png)](https://pypi.python.org/pypi/flopy) [![Coverage Status](https://coveralls.io/repos/github/modflowpy/flopy/badge.svg?branch=develop)](https://coveralls.io/github/modflowpy/flopy?branch=develop) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b23a5edd021b4aa19e947545ab49e577)](https://www.codacy.com/app/jdhughes-usgs/flopy?utm_source=github.com&utm_medium=referral&utm_content=modflowpy/flopy&utm_campaign=Badge_Grade) +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b23a5edd021b4aa19e947545ab49e577)](https://www.codacy.com/app/jdhughes-usgs/flopy?utm_source=github.com&utm_medium=referral&utm_content=modflowpy/flopy&utm_campaign=Badge_Grade)[![Binder](https://aws-uswest2-binder.pangeo.io/badge_logo.svg)](https://aws-uswest2-binder.pangeo.io/v2/gh/modflowpy/flopy.git/develop?filepath=https%3A%2F%2Fgithub.com%2Fmodflowpy%2Fflopy%2Ftree%2Fdevelop%2Fexamples%2FNotebooks) Introduction ----------------------------------------------- @@ -111,7 +111,7 @@ Installation **Python versions:** -FloPy requires **Python** 2.7 or **Python** 3.3 (or higher) +FloPy requires **Python** 2.7 or **Python** 3.5 (or higher). **Support for Python versions < 3.5 will be dropped in the next version of FloPy (version 3.3.0)** **Dependencies:** @@ -234,4 +234,3 @@ functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software. - diff --git a/binder/environment.yml b/binder/environment.yml new file mode 100644 index 0000000000..bbf9d11e51 --- /dev/null +++ b/binder/environment.yml @@ -0,0 +1,25 @@ +name: pyclass +channels: + - conda-forge +dependencies: + - numpy + - matplotlib + - xarray + - requests + - pandas + - python-dateutil + - xlrd + - gdal + - geopandas + - rtree + - descartes + - shapely + - scipy + - netcdf4 + - pyproj>=2.0 + - rasterio>=1.0 + - rasterstats + - pyshp + - hydrofunctions + - flopy + - pip diff --git a/binder/postBuild b/binder/postBuild new file mode 100644 index 0000000000..6cb3e17ac4 --- /dev/null +++ b/binder/postBuild @@ -0,0 +1,6 @@ +#!/bin/bash + +curl -L -o linux.zip https://github.com/MODFLOW-USGS/executables/releases/download/2.0/linux.zip?raw=true +mkdir binaries +unzip linux.zip -d binaries +rm linux.zip diff --git a/binder/start b/binder/start new file mode 100644 index 0000000000..703f687182 --- /dev/null +++ b/binder/start @@ -0,0 +1,5 @@ +#!/bin/bash + +export PATH=/home/jovyan/binaries/:$PATH + +exec "$@" diff --git a/docs/notebook_examples.md b/docs/notebook_examples.md index 54aea3b9d6..1243f6859a 100644 --- a/docs/notebook_examples.md +++ b/docs/notebook_examples.md @@ -3,7 +3,9 @@ Examples ### jupyter Notebook Examples -The following jupyter Notebooks contain examples for using FloPy pre- and post-processing capabilities with a variety of MODFLOW-based models. +The following jupyter Notebooks contain examples for using FloPy pre- and post-processing capabilities with a variety of MODFLOW-based models. The FloPy example notebooks can be opened and run using Pangeo by clicking on the launch binder link below. + +[![Binder](https://aws-uswest2-binder.pangeo.io/badge_logo.svg)](https://aws-uswest2-binder.pangeo.io/v2/gh/modflowpy/flopy.git/develop?filepath=https%3A%2F%2Fgithub.com%2Fmodflowpy%2Fflopy%2Ftree%2Fdevelop%2Fexamples%2FNotebooks) #### MODFLOW-2000, MODFLOW-2005, MODFLOW-NWT, MODFLOW-USG, MODPATH, MT3DMS, MT3D-USGS, and SEAWAT @@ -43,11 +45,11 @@ The following jupyter Notebooks contain examples for using FloPy pre- and post-p + An overview of using FloPy and GRIDGEN to creating layered quadtree grids for MODFLOW-USG is given in the [flopy3_gridgen](../examples/Notebooks/flopy3_gridgen.ipynb) Notebook. See the [flopy3_Modpath7_unstructured_example](../examples/Notebooks/flopy3_Modpath7_unstructured_example.ipynb) Notebook for an example of using GRIDGEN to create an unstructured DISV quadtree discretization for MODFLOW 6. -+ The [lake example](../examples/Notebooks/flopy3_lake_example.ipynb), a very simple FloPy example of steady flow in a square model with a fixed head cell in the middle (representing a lake) in a 10-layer model. ++ The [lake example](../examples/Notebooks/flopy3_lake_example.ipynb), a very simple FloPy example of steady flow in a square model with a fixed head cell in the middle (representing a lake) in a 10-layer model. + A variant of the [water-table example](../examples/Notebooks/flopy3_WatertableRecharge_example.ipynb), a very simple example of one-dimensional groundwater flow in an unconfined aquifer with recharge, from the MODFLOW-NWT documentation (http://pubs.usgs.gov/tm/tm6a37/). This IPython Notebook build files for MODFLOW-NWT. -+ The [Zaidel discontinuous water-table example](../examples/Notebooks/flopy3_Zaidel_example.ipynb), which simulates a discontinuous water table over a stairway impervious base, from http://onlinelibrary.wiley.com/doi/10.1111/gwat.12019/abstract. This IPython Notebook build files for MODFLOW-USG. (http://pubs.usgs.gov/tm/06/a45/). ++ The [Zaidel discontinuous water-table example](../examples/Notebooks/flopy3_Zaidel_example.ipynb), which simulates a discontinuous water table over a stairway impervious base, from http://onlinelibrary.wiley.com/doi/10.1111/gwat.12019/abstract. This IPython Notebook build files for MODFLOW-USG. (http://pubs.usgs.gov/tm/06/a45/). + The [MT3DMS Example Problems](../examples/Notebooks/flopy3_MT3DMS_examples.ipynb), which uses to Flopy to reproduce the ten example problems described in the MT3DMS documentation report by Zheng and Wang (1999). @@ -113,7 +115,7 @@ The following jupyter Notebooks contain examples for using FloPy pre- and post-p + An overview of options for adding observations, time series, and time array series to MODFLOW 6 packages is given in the [flopy3_mf6_obs_ts_tas](../examples/Notebooks/flopy3_mf6_obs_ts_tas.ipynb) Notebook. -#### Model grid examples +#### Model grid examples + An overview of the FloPy [model grid class capabilities](../examples/Notebooks/flopy3_demo_of_modelgrid_classes.ipynb). @@ -142,4 +144,3 @@ The following jupyter Notebooks contain examples for using FloPy pre- and post-p #### Additional MODFLOW examples + Example problems from the 2015 2nd edition of [Applied Groundwater Modeling](https://github.com/Applied-Groundwater-Modeling-2nd-Ed) by Mary P. Anderson, William W. Woessner, and Randall J. Hunt (https://github.com/Applied-Groundwater-Modeling-2nd-Ed) -