Download and Installation

The alternative ways to download and install the subgroups python library are described as follows.

Quick install

The easiest way to obtain this library is from either PyPI (the Python Package Index) or Conda.

PyPI

For that, you can view and download the package from its PyPI page or directly install it by executing:

pip install subgroups

Conda

For that, you can view and download the package from its Anaconda.org page (conda-forge channel) or directly install it by executing:

conda install -c conda-forge subgroups

Testing

After installing the library, a collection of tests can be launched by executing:

import subgroups.tests as st
st.run_all_tests()

These tests verify that the library is correctly installed and that all components, algorithms and features are properly working.

Installing from source

The source code (latest development) is currently hosted on GitHub.

Therefore, you need first to clone the repository:

git clone https://github.com/antoniolopezmc/subgroups.git
cd subgroups

After that, the library can be installed in production mode or in develop mode.

Production mode

make install_prod

or

python -m pip install ./

or

pip install ./

This mode installs the library as normal, copying it to the standard Python site-packages directory.

Develop mode

make install_dev

or

python -m pip install -e ./

or

pip install -e ./

This mode installs the library in editable mode, creating a link in the standard Python site-packages directory to the downloaded project directory (the current directory). See the pip_install documentation for further details.

Documentation

The source code of the project also contains a folder called docs, which includes the documentation of the library (the documentation that you are reading). This documentation can be also manually generated by executing:

cd docs
make build

or

cd docs
python clean.py source/project_files build
python -m pip install --upgrade sphinx
python -m pip install --upgrade sphinx-rtd-theme
python -m pip install --upgrade sphinx-autodoc-typehints
sphinx-apidoc -f -T -M -o source/project_files ../src/subgroups
sphinx-build -M html source build

The generated documentation will be located in the build subfolder.