Installing¶

Which Python?¶

You’ll need Python 3.6 or greater.

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.

Install from PyPi¶

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 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 main 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 .

Python package dependencies¶

hyppo requires the following:

python (>= 3.6)
numba (>= 0.46)
numpy (>= 1.17)
scipy (>= 1.4.0)
scikit-learn (>= 0.22)
joblib (>= 0.17.0)

Hardware requirements¶

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.

Testing¶

hyppo uses the Python pytest testing package. If you don't already have that package installed, follow the directions on the pytest homepage.