mibitrans is an analytical subsurface contaminant transport modelling tool based on the three-dimensional advection–dispersion equation. mibitrans has a clear and quick parameter input and various model options, which allow for easy visualization of contaminant transport under various field conditions. The package is designed to be modular and well documented, to allow users to adapt a model to their liking. mibitrans is develloped as a screening tool to gain insights into field site contaminant distribution, which then can be used in development of more involved numerical models. The package is also well suited in contaminant transport visualization for educational purposes.

Installation of stable release

Use pip to install the most recent stable release of mibitrans as follows:

pip install mibitrans

Installation of most recent development version

To install mibitrans from the GitHub repository directly, do:

git clone git@github.com:MiBiPreT/mibitrans.git
cd mibitrans
python -m pip install .

Note that this is the (possibly unstable) development version from the main branch. If you want a stable release, use the pip installation method instead.

Documentation

See the full mibitrans documentation here

Contributing

If you want to contribute to the development of mibitrans, have a look at the contribution guidelines.

Credits

This package was created with Cookiecutter and the NLeSC/python-template.