Quick Start Installation Guide

NOTE: PusH is currently only tested on Linux (Ubuntu 20.04 LTS). It is not known to work on other operating systems, including Windows.

Environment Setup

It is recommended to use a virtual environment for PusH installation. Conda and venv are popular virtual environment tools. Python version 3.10 or higher is required. The commands below can be used to create an environment.

conda create -n push_env python=3.10
conda activate push_env

Method 1: Installation from PyPi

  1. PusH can be installed from the TestPyPi repository using pip. It is NOT recommended to install dependencies from the TestPyPi site since the TestPyPi repo contains different packages from the main PyPi repo.

pip install -i https://test.pypi.org/simple/ push --no-deps

  1. PusH requires dependencies. Install these separately from the previous step.

  • PyTorch version 2.1.0 or greater

  • NumPy version 1.26.0 or greater

  • tqdm version 4.66.1 or greater

pip install torch numpy tqdm

Method 2: Installation from Source

  1. PusH can also be installed from source. This is generally for advanced users or contributors to PusH development. It also includes docs and experiments which have their own dependencies aside from those used by the base library.

git clone git@github.com:lbai-lab/push.git

  1. After downloading the repository, navigate to the root of the download (contains pyproject.toml). Use pip to install PusH, which will also install dependencies.

pip install -e .

Testing Source Installation

You can test the installation of PusH by running the following script from the root folder.

./run_tests.sh