flopy

A Python package to create, run, and post-process MODFLOW-based models.
https://github.com/modflowpy/flopy

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords

modeling plotting python

Keywords from Contributors

groundwater modflow hydrology earth-science groundwater-modelling pastas water geopandas flopy parallel-computing

Last synced: about 1 hour ago
JSON representation

Repository metadata

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

• Host: GitHub
• URL: https://github.com/modflowpy/flopy
• Owner: modflowpy
• License: other
• Created: 2014-12-14T16:50:55.000Z (about 11 years ago)
• Default Branch: develop
• Last Pushed: 2025-11-27T16:26:48.000Z (27 days ago)
• Last Synced: 2025-11-27T23:24:00.050Z (27 days ago)
• Topics: modeling, plotting, python
• Language: Python
• Homepage: https://flopy.readthedocs.io
• Size: 635 MB
• Stars: 590
• Watchers: 34
• Forks: 349
• Open Issues: 56
• Releases: 33
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Support: docs/supported_packages.md

README.md

numpy >=1.15.0,<2.0.0
matplotlib >=1.4.0
pandas >=2.0.0

conda install -c conda-forge flopy

pip install flopy

get-modflow :

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 = gwf.output.head().get_data()
bud = gwf.output.budget()

spdis = bud.get_data(text='DATA-SPDIS')[0]
qx, qy, qz = flopy.utils.postprocessing.get_specific_discharge(spdis, gwf)
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_vector(qx, qy, normalize=True, color="white")

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

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite both the article from preferred-citation,
  references, and the software itself.
type: software
title: FloPy
version: 3.7.0.dev0
date-released: '2024-02-08'
doi: 10.5066/F7BK19FH
abstract: A Python package to create, run, and post-process MODFLOW-based models.
repository-artifact: https://pypi.org/project/flopy
repository-code: https://github.com/modflowpy/flopy
license: CC0-1.0
authors:
- family-names: Bakker
  given-names: Mark
  orcid: https://orcid.org/0000-0002-5629-2861
- family-names: Post
  given-names: Vincent
  orcid: https://orcid.org/0000-0002-9463-3081
- family-names: Hughes
  given-names: Joseph D.
  orcid: https://orcid.org/0000-0003-1311-2354
- family-names: Langevin
  given-names: Christian D.
  orcid: https://orcid.org/0000-0001-5610-9759
- family-names: White
  given-names: Jeremy T.
  orcid: https://orcid.org/0000-0002-4950-1469
- family-names: Leaf
  given-names: Andrew T.
  orcid: https://orcid.org/0000-0001-8784-4924
- family-names: Paulinski
  given-names: Scott R.
  orcid: https://orcid.org/0000-0001-6548-8164
- family-names: Bellino
  given-names: Jason C.
  orcid: https://orcid.org/0000-0001-9046-9344
- family-names: Morway
  given-names: Eric D.
  orcid: https://orcid.org/0000-0002-8553-6140
- given-names: Michael W.
  family-names: Toews
  orcid: https://orcid.org/0000-0003-3657-7963
- family-names: Larsen
  given-names: Joshua D.
  orcid: https://orcid.org/0000-0002-1218-800X
- family-names: Fienen
  given-names: Michael N.
  orcid: https://orcid.org/0000-0002-7756-4651
- family-names: Starn
  given-names: Jon Jeffrey
  orcid: https://orcid.org/0000-0001-5909-0010
- family-names: Brakenhoff
  given-names: Davíd A.
  orcid: https://orcid.org/0000-0002-2993-2202
- family-names: Bonelli
  given-names: Wesley P.
  orcid: https://orcid.org/0000-0002-2665-5078
preferred-citation:
  type: article
  authors:
  - family-names: Hughes
    given-names: Joseph D.
    orcid: https://orcid.org/0000-0003-1311-2354
  - family-names: Langevin
    given-names: Christian D.
    orcid: https://orcid.org/0000-0001-5610-9759
  - family-names: Paulinski
    given-names: Scott R.
    orcid: https://orcid.org/0000-0001-6548-8164
  - family-names: Larsen
    given-names: Joshua D.
    orcid: https://orcid.org/0000-0002-1218-800X
  - family-names: Brakenhoff
    given-names: David
    orcid: https://orcid.org/0000-0002-2993-2202
  title: FloPy Workflows for Creating Structured and Unstructured MODFLOW Models
  doi: 10.1111/gwat.13327
  journal: Groundwater
  year: 2023
  month: 5
references:
- authors:
  - family-names: Bakker
    given-names: Mark
    orcid: https://orcid.org/0000-0002-5629-2861
  - family-names: Post
    given-names: Vincent
    orcid: https://orcid.org/0000-0002-9463-3081
  - family-names: Langevin
    given-names: Christian D.
    orcid: https://orcid.org/0000-0001-5610-9759
  - family-names: Hughes
    given-names: Joseph D.
    orcid: https://orcid.org/0000-0003-1311-2354
  - family-names: White
    given-names: Jeremy T.
    orcid: https://orcid.org/0000-0002-4950-1469
  - family-names: Starn
    given-names: Jon Jeffrey
    orcid: https://orcid.org/0000-0001-5909-0010
  - family-names: Fienen
    given-names: Michael N.
    orcid: https://orcid.org/0000-0002-7756-4651
  type: article
  title: Scripting MODFLOW Model Development Using Python and FloPy
  doi: 10.1111/gwat.12413
  journal: Groundwater
  volume: 54
  issue: 5
  start: 733
  end: 739
  year: 2016
  month: 9

Owner metadata

• Name: modflowpy
• Login: modflowpy
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/10146746?v=4
• Repositories: 4
• Last ynced at: 2023-02-27T09:10:31.487Z
• Profile URL: https://github.com/modflowpy

GitHub Events

Total

• Create event: 37
• Release event: 6
• Issues event: 87
• Watch event: 58
• Delete event: 24
• Issue comment event: 327
• Push event: 157
• Pull request event: 310
• Pull request review event: 208
• Pull request review comment event: 166
• Fork event: 41

Last Year

• Create event: 35
• Release event: 6
• Issues event: 75
• Watch event: 51
• Delete event: 21
• Issue comment event: 266
• Push event: 129
• Pull request review comment event: 130
• Pull request review event: 149
• Pull request event: 262
• Fork event: 36

Committers metadata

Last synced: 6 days ago

Committer domains:

• usgs.gov: 10
• artesia-water.nl: 2
• deltares.nl: 2
• ucar.edu: 1
• witteveenbos.com: 1
• igsaaahmltw272v.gs.doi.net: 1
• igsaaa071l01144.gs.doi.net: 1
• gns.cri.nz: 1
• axiomalaska.com: 1
• igskiacwvmgs007.gs.doi.net: 1
• ing.uchile.cl: 1
• soe70924.isd.ad.flinders.edu.au: 1
• brabantwater.nl: 1
• ucdavis.edu: 1
• gs.doi.net: 1
• mac7262.gns.cri.nz: 1
• rhdhv.com: 1
• seequent.com: 1
• gwscience.co.uk: 1
• itascadenver.com: 1
• edinsi.nl: 1
• bluegeo.ca: 1
• email.arizona.edu: 1
• nelen-schuurmans.nl: 1
• pm.me: 1
• python-academy.de: 1

Issue and Pull Request metadata

Last synced: 10 days ago

Package metadata

• Total packages: 2
• Total downloads:
  • pypi: 53,074 last-month
• Total docker downloads: 5,769
• Total dependent packages: 19 (may contain duplicates)
• Total dependent repositories: 45 (may contain duplicates)
• Total versions: 72
• Total maintainers: 2

Score: 21.824200198847812