Metadata-Version: 2.1
Name: modflowapi
Version: 0.1.0
Summary: modflowapi is an extension to the xmipy Python package
Author-email: "Joseph D. Hughes" <jdhughes@usgs.gov>, Martijn Russcher <Martijn.Russcher@deltares.nl>, "Christian D. Langevin" <langevin@usgs.gov>, Julian Hofer <Julian.Hofer@deltares.nl>, "Joshua D. Larsen" <jlarsen@usgs.gov>
Maintainer-email: "Joseph D. Hughes" <jdhughes@usgs.gov>
License: CC0
Project-URL: Repository, https://github.com/MODFLOW-USGS/modflowapi
Project-URL: Publication, https://doi.org/10.1016/j.envsoft.2021.105257
Keywords: MODFLOW,groundwater,hydrogeology,bmi,xmi
Classifier: Intended Audience :: Science/Research
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: xmipy
Provides-Extra: dev
Requires-Dist: modflowapi[lint,test] ; extra == 'dev'
Provides-Extra: lint
Requires-Dist: black ; extra == 'lint'
Requires-Dist: flake8 ; extra == 'lint'
Requires-Dist: pylint ; extra == 'lint'
Provides-Extra: test
Requires-Dist: filelock ; extra == 'test'
Requires-Dist: modflow-devtools ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-order ; extra == 'test'
Requires-Dist: pytest-xdist ; extra == 'test'

# modflowapi

`modflowapi` is an extension to [xmipy](https://pypi.org/project/xmipy/) for the MODFLOW API.

The `modflowapi` 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.

Use of modflowapi and modflowapi extensions can be found in the [Quickstart](examples/notebooks/Quickstart.ipynb) and the [Extensions](examples/notebooks/MODFLOW-API_extensions_objects.ipynb) Notebooks. An example of using the MODFLOW API to monitor heads during a simulation can be found in the [Head Monitor Example](examples/notebooks/Head_Monitor_Example.ipynb) Notebook. 


`modflowapi` can be installed by running

```
pip install modflowapi
```

or

```
conda install -c conda-forge modflowapi
```

### 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](https://doi.org/10.1016/j.envsoft.2021.105257).
