Metadata-Version: 2.1
Name: xmipy
Version: 1.3.1
Summary: xmipy is an extension to the bmipy Python package
Author-email: Martijn Russcher <Martijn.Russcher@deltares.nl>, Julian Hofer <Julian.Hofer@deltares.nl>, "Joseph D. Hughes" <jdhughes@usgs.gov>
License: CC0
Project-URL: Documentation, https://deltares.github.io/xmipy/xmipy.html
Project-URL: Source, https://github.com/Deltares/xmipy
Keywords: BMI,Basic Model Interface
Classifier: Intended Audience :: Science/Research
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bmipy
Requires-Dist: numpy
Provides-Extra: docs
Requires-Dist: pdoc ; extra == 'docs'
Provides-Extra: lint
Requires-Dist: black ; extra == 'lint'
Requires-Dist: ruff ; extra == 'lint'
Requires-Dist: mypy ; extra == 'lint'
Provides-Extra: tests
Requires-Dist: flopy (>=3.3.6) ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: requests ; extra == 'tests'

# xmipy

![Continuous integration](https://github.com/Deltares/xmipy/workflows/Continuous%20integration/badge.svg)
[![codecov](https://codecov.io/gh/Deltares/xmipy/branch/develop/graph/badge.svg)](https://codecov.io/gh/Deltares/xmipy)


`xmipy` is an extension to [bmipy](https://pypi.org/project/bmipy/) including an implementation of the abstract methods.
The extended interface is required to couple certain hydrological kernels, particularly MODFLOW 6. Currently it is a joint development of the USGS and Deltares. The [imod_coupler](https://github.com/Deltares/imod_coupler) uses it, for example, to couple Modflow 6 and MetaSWAP.

`xmipy` can be installed by running
```
pip install xmipy
```

# Contributing

In order to develop on `xmipy` locally, execute the following line inside your virtual environment

```bash
pip install -e ".[tests, lint, docs]"
```
