kingmanzhang / mutual-information

mutual information

This is a python package that calculates the synergy between two or more variables for one response.

installation

install from pypi:

pip install mutual-information

how to contribute

We recommend using pipenv to manage virtual environment, and pybuilder to build packages.

To activate the virtual environment, within this repo

pip install pipenv
pipenv shell
pipenv install --dev

If you use Pycharm, the virtual environment should be auto-activated.

To run unittests

pyb run_unit_tests

To build the package

pyb

usage

@TODO: will be added