Installation

Groupyr requires Python 3.6, 3.7, or 3.8 and depends on

copt numpy scikit-learn scipy scikit-optimize tqdm

Installing the release version

The recommended way to install groupyr is from PyPI,

$ pip install groupyr

This will install groupyr and all of its dependencies.

Installing the development version

The development version is less stable but may include new features. You can install the development version using pip:

pip install git+https://github.com/richford/groupyr.git

Alternatively, you can clone the source code from the github repository:

$ git clone git@github.com:richford/groupyr.git
$ cd groupyr
$ pip install .

If you would like to contribute to groupyr, see the contributing guidelines.

Next, go to the user guide or see the example gallery for further information on how to use groupyr.

Dependencies

Installing groupyr using either of the methods above will install all of its dependencies: copt, numpy, scikit-learn, scipy, scikit-optimize, and tqdm.