modflowapi
An extension to xmipy for the MODFLOW API.
Introduction
The modflowapi Python package can be used to access functionality in the eXtended Model Interface (XMI) wrapper (XmiWrapper)
and additional functionality specific to the MODFLOW API. Currently it is a joint development of the USGS and Deltares.
Installation
modflowapi requires Python 3.12+, with:
numpy
pandas
xmipy
To install modflowapi with pip:
pip install modflowapi
Or with conda:
conda install -c conda-forge modflowapi
Documentation
Documentation is available on ReadTheDocs.
Examples using modflowapi and its extensions can be found in the Quickstart and the Extensions notebooks. An example of using the MODFLOW API to monitor heads during a simulation can be found in the Head Monitor Example Notebook.
For more info on MODFLOW 6 see the USGS overview.
Citation
Hughes, Joseph D., Russcher, M. J., Langevin, C. D., Morway, E. D. and McDonald, R. R., 2022, The MODFLOW Application Programming Interface for simulationcontrol and software interoperability: Environmental Modelling & Software, v. 148, p. 105257, doi:10.1016/j.envsoft.2021.105257.
Papers featuring the MODFLOW 6 API
Release files for modflowapi 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| modflowapi-1.0.2.tar.gz | 23.3 kB | With provenance | Details for modflowapi-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| modflowapi-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for modflowapi-1.0.2-py3-none-any.whl |
Total release size: 50.4 kB
Release files / modflowapi-1.0.2.tar.gz
| Download URL | modflowapi-1.0.2.tar.gz |
|---|---|
| Size | 23.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
872222983286f66cc9ad0f067872cbd3d19d8b3323a49f8154345915d7471288
|
|
BLAKE2b-256 checksum How to use checksums |
33eeb1caa2c2584c00083b9f4e7d11ccab55b5e8cf82a2c964e620e00e63128e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.
Transparency logRelease files / modflowapi-1.0.2-py3-none-any.whl
| Download URL | modflowapi-1.0.2-py3-none-any.whl |
|---|---|
| Size | 27.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
06e9ae5d8c5f10cadf0b4a0b3816af3e53eae48796cf0f806d52e7f905abcf02
|
|
BLAKE2b-256 checksum How to use checksums |
3c8acaf77c7614c36f697e48af907d187cb87f64822791cd74d0e0ee89f71664
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.
Transparency logSecurity for modflowapi 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for modflowapi-1.0.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
