Need help with flopy?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

modflowpy
227 Stars 201 Forks 3.3K Commits 28 Opened issues

Description

A Python package to create, run, and post-process MODFLOW-based models.

Services available

!
?

Need anything else?

Contributors list

No Data

flopy3

Version 3.3.3 — release candidate

Build Status codecov Codacy Badge Documentation Status

Anaconda-Server Badge Anaconda-Server Badge PyPI Version

Binder

Introduction

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

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.

Installation

FloPy requires Python 3.5 (or higher) and NumPy 1.9 (or higher). Dependencies for optional FloPy methods are summarized here.

To install FloPy type:

conda install -c conda-forge flopy

or

pip install flopy

The release candidate version can also be installed from the git repository using the instructions provided below.

Documentation

FloPy code documentation is available at https://flopy.readthedocs.io

Getting Started

MODFLOW 6 Quick Start

import os
import flopy
ws = './mymodel'
name = 'mymodel'
sim = flopy.mf6.MFSimulation(sim_name=name, sim_ws=ws, exe_name='mf6')
tdis = flopy.mf6.ModflowTdis(sim)
ims = flopy.mf6.ModflowIms(sim)
gwf = flopy.mf6.ModflowGwf(sim, modelname=name, save_flows=True)
dis = flopy.mf6.ModflowGwfdis(gwf, nrow=10, ncol=10)
ic = flopy.mf6.ModflowGwfic(gwf)
npf = flopy.mf6.ModflowGwfnpf(gwf, save_specific_discharge=True)
chd = flopy.mf6.ModflowGwfchd(gwf, stress_period_data=[[(0, 0, 0), 1.],
                                                       [(0, 9, 9), 0.]])
budget_file = name + '.bud'
head_file = name + '.hds'
oc = flopy.mf6.ModflowGwfoc(gwf,
                            budget_filerecord=budget_file,
                            head_filerecord=head_file,
                            saverecord=[('HEAD', 'ALL'), ('BUDGET', 'ALL')])
sim.write_simulation()
sim.run_simulation()
head = flopy.utils.HeadFile(os.path.join(ws, head_file)).get_data()
bud = flopy.utils.CellBudgetFile(os.path.join(ws, budget_file),
                                 precision='double')
spdis = bud.get_data(text='DATA-SPDIS')[0]
pmv = flopy.plot.PlotMapView(gwf)
pmv.plot_array(head)
pmv.plot_grid(colors='white')
pmv.contour_array(head, levels=[.2, .4, .6, .8], linewidths=3.)
pmv.plot_specific_discharge(spdis, color='white')

plot

Additional FloPy Resources

  • Tutorials demonstrating basic FloPy use.

  • MODFLOW 6 Example Problems demonstrating FloPy use to create, run, and post-process MODFLOW 6 models.

  • Jupyter notebooks demonstrating the use of FloPy pre- and post-processing capabilities with a variety of MODFLOW-based models.

  • Scripts demonstrating the use of FloPy for running and post-processing MODFLOW-based models.

  • A list of supported packages in FloPy is available in docs/supported_packages.md on the github repo.

  • 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.

Questions

FloPy usage has been growing rapidly, and as the number of users has increased, so has the number of questions about how to use FloPy. We ask our users to carefully consider the nature of their problem and seek help in the appropriate manner.

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on Stack Overflow where the questions should be tagged with tag

flopy
or the MODFLOW google group.

Stack Overflow is a much better place to ask questions since:

  • there are thousands of people willing to help on Stack Overflow and the MODFLOW google group
  • questions and answers stay available for public viewing so your question / answer might help someone else
  • Stack Overflow's voting system assures that the best answers are prominently visible.

To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow or the MODFLOW google group.

Contributing

Bug reports, code contributions, or improvements to the documentation are welcome from the community. Prior to contributing, please read up on our guidelines for contributing and then check out one of our issues in the hotlist: community-help.

Installing the latest FloPy release candidate

To install the latest release candidate type:

pip install https://github.com/modflowpy/flopy/zipball/develop

How to Cite

Citation for FloPy:

Bakker, Mark, Post, Vincent, 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, Mark, Post, Vincent, Langevin, C. D., Hughes, J. D., White, J. T., Leaf, A. T., Paulinski, S. R., Larsen, J. D., Toews, M. W., Morway, E. D., Bellino, J. C., Starn, J. J., and Fienen, M. N., 2020, FloPy v3.3.3 — release candidate: U.S. Geological Survey Software Release, 27 October 2020, http://dx.doi.org/10.5066/F7BK19FH

MODFLOW Resources

Disclaimer

This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.