flopy 2.2.353__zip → 3.0.2__zip

flopy-3.0.2/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 1.0
+Name: flopy
+Version: 3.0.2
+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/basic/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
+        ------------
+        
+        To install *FloPy3* type:
+        
+        ::
+        
+            pip install flopy
+        
+        To update *FloPy3* type:
+        
+        ::
+        
+            pip install flopy --upgrade
+        
+        To uninstall *FloPy3* type:
+        
+        ::
+        
+            pip uninstall flopy
+        
+        To install the bleeding edge version of *FloPy3* from the git repository
+        type:
+        
+        ::
+        
+            pip install git+https://github.com/modflowpy/flopy.git
+        
+        To update your version of *FloPy3* with the bleeding edge code from the
+        git repository type:
+        
+        ::
+        
+            pip install git+https://github.com/modflowpy/flopy.git --upgrade
+        
+        Documentation
+        -------------
+        
+        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
+        ^^^^^^^^^^^^^^
+        
+        -  The `lake
+           example <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/basic/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.
+        -  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/basic/flopy3boundaries.ipynb>`__
+           Notebook
+        -  The `Henry
+           Problem <http://nbviewer.ipython.org/github/modflowpy/flopy/blob/master/examples/henry/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/swi_examples/swiex1.ipynb>`__
+           of the SWI2 manual, simulating a rotating interface.
+        
+        SWI2 Test Problems for *FloPy3*
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+        
+        A zip file containing *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/>`__ is available at:
+        
+        -  http://flopy.googlecode.com/svn/examples/SWI2ExampleProblems_flopy.zip
+        
+        Note that examples 2 and 5 also include *FloPy3* scripts 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

flopy-3.0.2/flopy/__init__.py

@@ -0,0 +1,32 @@
+"""
+The FloPy package consists of a set of Python scripts to run MODFLOW, MT3D,
+SEAWAT and other MODFLOW-related groundwater programs. FloPy enables you to
+run all these programs with Python scripts. The FloPy project started in 2009
+and has grown to a fairly complete set of scripts with a growing user base.
+
+This version of Flopy (FloPy3) was released in December 2015 with a few great
+enhancements that make FloPy3 backwards incompatible. The first significant
+change is that FloPy3 uses zero-based indexing everywhere, which means that
+all layers, rows, columns, and stress periods start numbering at zero. This
+change was made for consistency as all array-indexing was already zero-based
+(as are all arrays in Python). This may take a little getting-used-to, but
+hopefully will avoid confusion in the future. A second significant enhancement
+concerns the ability to specify time-varying boundary conditions that are
+specified with a sequence of layer-row-column-values, like the WEL and GHB
+packages. A variety of flexible and readable ways have been implemented to
+specify these boundary conditions. FloPy is an open-source project and any
+assistance is welcomed. Please email the development team if you want to
+contribute.
+
+"""
+
+__name__ = 'flopy'
+__author__ = 'Mark Bakker, Vincent Post, Chris Langevin, Joe Hughes, Jeremy White, Jeff Starn, Mike Fienen, and Alain Frances'
+from version import __version__, __build__
+
+#imports
+import modflow
+import mt3d
+import seawat
+import modpath
+import utils