Skip to content

neurodata/hyppo

Repository files navigation

hyppo

arXiv shield License PyPI version Netlify Status Maintainability Coverage Status Build Status PyPI - Downloads

hyppo (HYPothesis Testing in PythOn, pronounced "Hippo") is an open-source software package for multivariate hypothesis testing.

Note: We have recently moved our benchmarks (with relevant figure replication code for our papers) folder to a new repo! We aim to add test development code and paper figure replication code there, and will add relevant tests (with tutorials) to hyppo.

hyppo intends to be a comprehensive multivariate hypothesis testing package and runs on all major versions of operating systems. It also includes novel tests not found in other packages. It is quick to install and free of charge. If you need to use multivariate hypothesis testing, be sure to give hyppo a try!

Install Guide

The installation guide cange found found here: https://hyppo.neurodata.io/install.html. Relevant sections have been added below:

Below we assume you have the default Python environment already configured on your computer and you intend to install hyppo inside of it. If you want to create and work with Python virtual environments, please follow instructions on venv and virtual environments. We also highly recommend conda. For instructions to install this, please look at conda.

First, make sure you have the latest version of pip (the Python package manager) installed. If you do not, refer to the pip documentation and install pip first.

Install from PyPi

Install the current release of hyppo from the Terminal with pip:

pip install hyppo

To upgrade to a newer release use the --upgrade flag:

pip install --upgrade hyppo

If you do not have permission to install software systemwide, you can install into your user directory using the --user flag:

pip install --user hyppo

Install from Github

You can manually download hyppo by cloning the git repo master version and running the setup.py file. That is, unzip the compressed package folder and run the following from the top-level source directory using the Terminal:

git clone https://github.com/neurodata/hyppo
cd hyppo
python3 setup.py install

Or, alternatively, you can use pip:

git clone https://github.com/neurodata/hyppo
cd hyppo
pip install .

Other Important Information

hyppo requires the following packages as dependencies:

numba
numpy
scipy
scikit-learn

hyppo package requires only a standard computer with enough RAM to support the in-memory operations. This package is supported for all major operating systems. The following versions of operating systems was tested on Travis CI:

  • Linux: Ubuntu Xenial 16.04
  • Windows: Windows Server, version 1803