Skip to content

Documention for mibiscreen python package

github repo badge github license badge PyPI version RSD DOI fair-software.eu workflow scq badge workflow scc badge documentation build cffconvert sonarcloud markdown-link-check

mibiscreen

A Python package for prediction and analysis in Microbiome based Remediation. Developed as part of the MiBiRem toolbox for Bioremediation.

How to use mibiscreen

A collection of routines for data analysis on contaminant site data with the goal to predict if bioremediation is a feasible remediation strategy.

Installation

Installation of stable release

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

pip install mibiscreen

Installation of most recent development version

To install mibiscreen from the GitHub repository directly, do:

git clone git@github.com:MiBiPreT/mibiscreen.git
cd mibiscreen
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

You can find the project’s full documentation here.

Contributing

If you want to contribute to the development of mibiscreen, have a look at the contribution guidelines in CONTRIBUTING.md.

Credits

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