Gael-de-Sailly
/
flopy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,672 Commits
2 Branches
0 Tags
407 MiB
Python 100%
 
Go to file
Hughes, J.D 4da078208b Set theme jekyll-theme-minimal 2018-05-22 13:20:51 -04:00
autotest Restrict notebook and script autotests to released versions of python 3.6 2018-02-16 14:07:38 -05:00
docs 3.2.9 release 2018-02-19 11:59:21 -05:00
examples 3.2.9 release 2018-02-19 11:59:21 -05:00
flopy 3.2.9 release 2018-02-19 11:59:21 -05:00
.gitignore FIxed bug in STR related to incrementing a the k, i, j index of a recarray rather than a copy of the recarray. Updated a few markdown files. 2018-02-16 17:27:39 -05:00
.travis.yml Update travis.yml file 2017-12-05 15:46:04 -06:00
LICENSE Initial commit 2014-12-14 11:50:55 -05:00
MANIFEST.in Added the definition files to MANIFEST.in. These dfn files need to be explicitly mentioned so that they are included in the installation. 2017-12-17 07:48:37 -05:00
README.md 3.2.9 release 2018-02-19 11:59:21 -05:00
_config.yml Set theme jekyll-theme-minimal 2018-05-22 13:20:51 -04:00
builddistribution.py Modification to builddistribution.py 2015-07-31 12:44:53 -04:00
pre-commit.py A few improvements to pre-commit.py to improve making new releases 2017-12-01 18:03:10 -05:00
pre-commit.sh Added pre-commit files 2017-07-12 15:44:05 -04:00
requirements.travis.txt Updates to run notebooks. rasterio and scipy were creating problems so excluding them. 2017-11-29 13:59:16 -05:00
requirements2-34.travis.txt Updates to run notebooks 2017-11-29 14:42:13 -05:00
setup.py Merge master v 3.2.7 into develop 2017-12-01 16:00:24 -05:00

README.md

flopy3

Version 3.2.9

Build Status PyPI Version Coverage Status

Introduction

FloPy includes support for MODFLOW-2000, MODFLOW-2005, MODFLOW-NWT, and MODFLOW-USG. Other supported MODFLOW-based models include MODPATH (version 6), MT3DMS, MT3D-USGS, and SEAWAT.

FloPy now includes beta support for MODFLOW 6. Click here for more information.

For general modeling issues, please consult a modeling forum, such as the MODFLOW Users Group. Other MODFLOW resources are listed in the MODFLOW Resources section.

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. Pull requests will only be accepted on the develop branch of the repository.

Documentation

FloPy code documentation is available at http://modflowpy.github.io/flopydoc/

How to Cite

Citation for FloPy:

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, v. 54, p. 733–739, doi:10.1111/gwat.12413.

Software/Code citation for FloPy:

Bakker, M., Post, V., Langevin, C.D., Hughes, J.D., White, J.T., Starn, J.J., and Fienen, M.N., 2018, FloPy v3.2.9: U.S. Geological Survey Software Release, 19 February 2018, http://dx.doi.org/10.5066/F7BK19FH

Examples

jupyter Notebook Examples

Python Script Examples

Tutorials

Installation

Python versions:

FloPy requires Python 2.7 or Python 3.3 (or higher)

Dependencies:

FloPy requires NumPy 1.9 (or higher) and enum34 for Python 2.7 or Python 3.3.

Optional Method Dependencies:

Additional dependencies to use optional FloPy helper methods are listed below.

Method Python Package
.plot() matplotlib >= 1.4
.plot_shapefile() matplotlib >= 1.4 and Pyshp >= 1.2
.to_shapefile() Pyshp >= 1.2
.export(*.shp) Pyshp >= 1.2
.export(*.nc) netcdf4 >= 1.1 and python-dateutil >= 2.4
.export(*.tif) rasterio
.export(*.asc) in flopy.utils.reference SpatialReference class scipy.ndimage
.interpolate() in flopy.utils.reference SpatialReference class scipy.interpolate
.interpolate() in flopy.mf6.utils.reference StructuredSpatialReference class scipy.interpolate
.get_dataframes() in flopy.utils.mflistfile ListBudget class pandas >= 0.15
.get_dataframes() in flopy.utils.observationfile ObsFiles class pandas >= 0.15
.get_dataframes() in flopy.utils.sfroutputfile ModflowSfr2 class pandas >= 0.15
.get_dataframes() in flopy.utils.util_list MfList class pandas >= 0.15
.get_dataframes() in flopy.utils.zonebud ZoneBudget class pandas >= 0.15
.pivot_keyarray() in flopy.mf6.utils.arrayutils AdvancedPackageUtil class pandas >= 0.15
._get_vertices() in flopy.mf6.utils.binaryfile_utils MFOutputRequester class pandas >= 0.15
.get_dataframe() in flopy.mf6.utils.mfobservation Observations class pandas >= 0.15
.df() in flopy.modflow.mfsfr2 SfrFile class pandas >= 0.15
.time_coverage() in flopy.export.metadata acc class - used if available pandas >= 0.15
.loadtxt() in flopy.utils.flopyio - used if available pandas >= 0.15

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.

FloPy Changes

A summary of changes in each FloPy version is available in docs/version_changes.md on the github repo.

MODFLOW Resources