FloPy includes support for MODFLOW-2000, MODFLOW-2005, MODFLOW-NWT, and MODFLOW-USG. Other supported MODFLOW-based models include MODPATH (version 6), MT3D and SEAWAT.
If you think you have found a bug in FloPy, or if you would like to suggest an improvement or enhancement, please submit a new Issue through the Github Issue tracker toward the upper-right corner of this page. Pull requests will only be accepted on the develop branch of the repository.
FloPy code documentation is available at http://modflowpy.github.io/flopydoc/
FloPy is citable! Please see our paper in Groundwater:
Bakker, M., Post, V., Langevin, C. D., Hughes, J. D., White, J. T., Starn, J. J. and Fienen, M. N. (2016), Scripting MODFLOW Model Development Using Python and FloPy. Groundwater, 54: 733–739. doi:10.1111/gwat.12413
FloPy requires Python 2.7 or Python 3.3 (or higher)
FloPy requires NumPy 1.9 (or higher) and matplotlib 1.4 (or higher). The mapping and cross-section capabilities in the
flopy.plot submodule and shapefile export capabilities (
to_shapefile()) require Pyshp 1.2 (or higher). The NetCDF export capabilities in the
flopy.export submodule require python-dateutil 2.4 (or higher), netcdf4 1.1 (or higher), and pyproj 1.9 (or higher). Other NetCDF dependencies are detailed on the UniData website. The
get_dataframes method in the
ListBudget class in the
flopy.utils submodule require pandas 0.15 (or higher).
For base Python distributions:
To install FloPy type:
pip install flopy
To update FloPy type:
pip install flopy --upgrade
To uninstall FloPy type:
pip uninstall flopy
Installing from the git repository:
Current Version of FloPy:
To install the current version of FloPy from the git repository type:
pip install https://github.com/modflowpy/flopy/zipball/master
To update your version of FloPy with the current version from the git repository type:
pip install https://github.com/modflowpy/flopy/zipball/master --upgrade
Development version of FloPy:
To install the bleeding edge version of FloPy from the git repository type:
pip install https://github.com/modflowpy/flopy/zipball/develop
To update your version of FloPy with the bleeding edge code from the git repository type:
pip install https://github.com/modflowpy/flopy/zipball/develop --upgrade
FloPy Supported Packages
A list of supported packages in FloPy is available in docs/supported_packages.md on the github repo.
FloPy Model Checks
A table of the supported and proposed model checks implemented in FloPy is available in docs/model_checks.md on the github repo.
A summary of changes in each FloPy version is available in docs/version_changes.md on the github repo.