Metadata-Version: 1.0
Name: flopy
Version: 3.0.3
Summary: FloPy is a Python package to create, run, and post-process MODFLOW-based models.
Home-page: https://github.com/modflowpy/flopy/
Author: Mark Bakker, Vincent Post, Chris Langevin, Joe Hughes, Jeremy White, Jeff Starn, Mike Fienen, and Alain Frances
Author-email: mark.bakker@tudelft.nl, vincent.post@flinders.edu.au, langevin@usgs.gov, jdhughes@usgs.gov, jwhite@usgs.gov, jjstarn@usgs.gov, mnfienen@usgs.gov, frances.alain@gmail.com
License: New BSD
Description: Introduction

        ------------

        

        *FloPy3* includes support for MODFLOW-2000, MODFLOW-2005, and

        MODFLOW-NWT. Other supported MODFLOW-based models include MODPATH

        (version 6), MT3D and SEAWAT.

        

        FloPy3 Changes

        --------------

        

        *FloPy3* is significantly different from *FloPy2* (hosted on

        `googlecode <https://code.google.com/p/flopy/>`__). The main changes

        are:

        

        -  *FloPy3* is fully zero-based. This means that layers, rows and

           columns start counting at *zero*. The reason for this is consistency.

           Arrays are zero-based by default in Python, so it was confusing to

           have a mix.

        -  Input for packages that take *layer, row, column, data* input (like

           the wel or ghb package) has changed and is much more flexible now.

           See the notebook

           `flopy3boundaries <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/Notebooks/flopy3boundaries.ipynb>`__

        -  Support for use of EXTERNAL and OPEN/CLOSE array specifiers has been

           improved.

        -  *load()* methods have been developed for all of the standard MODFLOW

           packages and a few less used packages (*e.g.* SWI2).

        -  MODFLOW parameter support has been added to the *load()* methods.

           MULT, PVAL, and ZONE packages are now supported and parameter data

           are converted to arrays in the *load()* methods. MODFLOW parameters

           are not supported in *write()* methods. MULT package FUNCTION and

           EXPRESSION functionality are not currently supported.

        

        Installation

        ------------

        

        **Dependencies:**

        

        *FloPy3* requires **NumPy** 1.9 (or higher)

        

        +-------+

        | **For |

        | base  |

        | Pytho |

        | n     |

        | distr |

        | ibuti |

        | ons:* |

        | *     |

        +-------+

        | To    |

        | insta |

        | ll    |

        | *FloP |

        | y3*   |

        | type: |

        +-------+

        | pip   |

        | insta |

        | ll    |

        | flopy |

        +-------+

        | To    |

        | updat |

        | e     |

        | *FloP |

        | y3*   |

        | type: |

        +-------+

        | pip   |

        | insta |

        | ll    |

        | flopy |

        | --upg |

        | rade  |

        +-------+

        | To    |

        | unins |

        | tall  |

        | *FloP |

        | y3*   |

        | type: |

        +-------+

        | pip   |

        | unins |

        | tall  |

        | flopy |

        +-------+

        

        **For Anaconda distributions (osx-64 and win-64):**

        

        To install or update *FloPy3* with conda run:

        

        ::

        

            conda install -c https://conda.binstar.org/jdhughes flopy

        

        To uninstall *FloPy3* type:

        

        ::

        

            conda remove flopy   

        

        +-------+

        | **Dev |

        | elopm |

        | ent   |

        | versi |

        | ons   |

        | of    |

        | FloPy |

        | 3:**  |

        +-------+

        | To    |

        | insta |

        | ll    |

        | the   |

        | bleed |

        | ing   |

        | edge  |

        | versi |

        | on    |

        | of    |

        | *FloP |

        | y3*   |

        | from  |

        | the   |

        | git   |

        | repos |

        | itory |

        | type: |

        +-------+

        | pip   |

        | insta |

        | ll    |

        | git+h |

        | ttps: |

        | //git |

        | hub.c |

        | om/mo |

        | dflow |

        | py/fl |

        | opy.g |

        | it    |

        +-------+

        | To    |

        | updat |

        | e     |

        | your  |

        | versi |

        | on    |

        | of    |

        | *FloP |

        | y3*   |

        | with  |

        | the   |

        | bleed |

        | ing   |

        | edge  |

        | code  |

        | from  |

        | the   |

        | git   |

        | repos |

        | itory |

        | type: |

        +-------+

        | pip   |

        | insta |

        | ll    |

        | git+h |

        | ttps: |

        | //git |

        | hub.c |

        | om/mo |

        | dflow |

        | py/fl |

        | opy.g |

        | it    |

        | --upg |

        | rade  |

        +-------+

        | Docum |

        | entat |

        | ion   |

        +-------+

        

        Documentation for *FloPy3* is a work in progress. *FloPy3* code

        documentation is available at:

        

        -  http://modflowpy.github.io/flopydoc/

        

        Examples

        --------

        

        IPython Notebook Examples

        ~~~~~~~~~~~~~~~~~~~~~~~~~

        

        The following IPython Notebooks contain example FloPy scripts for a

        variety of models and FloPy features

        

        Basic examples

        ^^^^^^^^^^^^^^

        

        -  An overview of the options to enter *layer,row,column,data* values

           for packages such as the wel and ghb packages is given in the

           `flopy3boundaries <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/Notebooks/flopy3boundaries.ipynb>`__

           Notebook

        -  The `lake

           example <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/Notebooks/lake_example.ipynb>`__,

           a very simple *FloPy3* 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 <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/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 <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/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 `Henry

           Problem <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/Notebooks/henry.ipynb>`__,

           a simple saltwater intrusion model developed with Flopy and run using

           SEAWAT.

        

        SWI2 examples

        ^^^^^^^^^^^^^

        

        -  `Example

           1 <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/Notebooks/swiex1.ipynb>`__

           of the SWI2 manual, simulating a rotating interface.

        

        -  `Example

           4 <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/Notebooks/swiex4.ipynb>`__

           of the SWI2 manual, upconing below a pumping well below a two-aquifer

           island system.

        

        SWI2 Test Problems for *FloPy3*

        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        

        *FloPy3* scripts for running and post-processing the SWI2 Examples

        (examples 1 to 5) that are described in `Bakker et al.

        (2013) <http://pubs.usgs.gov/tm/6a46/>`__ are available:

        

        -  `SWI2 Example

           1 <https://github.com/modflowpy/flopy/blob/master/examples/scripts/flopy_swi2_ex1.py>`__

        

        -  `SWI2 Example

           2 <https://github.com/modflowpy/flopy/blob/master/examples/scripts/flopy_swi2_ex2.py>`__

        

        -  `SWI2 Example

           3 <https://github.com/modflowpy/flopy/blob/master/examples/scripts/flopy_swi2_ex3.py>`__

        

        -  `SWI2 Example

           4 <https://github.com/modflowpy/flopy/blob/master/examples/scripts/flopy_swi2_ex4.py>`__

        

        -  `SWI2 Example

           5 <https://github.com/modflowpy/flopy/blob/master/examples/scripts/flopy_swi2_ex5.py>`__

        

        Note that examples 2 and 5 also include *FloPy3* code for running and

        post-processing SEAWAT models.

        

        Tutorials

        ~~~~~~~~~

        

        A few simple *FloPy3* tutorials are available at:

        

        -  http://modflowpy.github.io/flopydoc/tutorials.html

        

        MODFLOW Resources

        ~~~~~~~~~~~~~~~~~

        

        -  `MODFLOW and Related Programs <http://water.usgs.gov/ogw/modflow/>`__

        -  `Online guide for

           MODFLOW-2000 <http://water.usgs.gov/nrp/gwsoftware/modflow2000/Guide/index.html>`__

        -  `Online guide for

           MODFLOW-2005 <http://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/>`__

        -  `Online guide for

           MODFLOW-NWT <http://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/>`__

        
Platform: Windows
Platform: Mac OS-X
