Installation

Stable release

PyPI

To install patpy, run this command in your terminal:

pip install patpy

This is the preferred method to install patpy, as it will always install the most recent stable release. If you don’t have pip installed, this Python installation guide can guide you through the process.

Development version

You can install the most recent version from GitHub:

pip install git+https://github.com/lueckenlab/patpy.git@main

Additional dependency groups

patpy comes with several optional dependency groups that can be installed based on your needs. Besides groups for development or docs, there are sample representation methods with tricky dependencies. To work with them, install dependencies with the examples below.

Development tools

pip install "patpy[dev]"

Documentation

pip install "patpy[doc]"

Testing dependencies

pip install "patpy[test]"

MRVI sample representation method

pip install "patpy[mrvi]"

PILOT sample representation method

pip install "patpy[pilot]"

scPoli sample representation method

pip install "patpy[scpoli]"

DiffusionEMD sample representation method

pip install "patpy[diffusionemd]"

You can also install multiple dependency groups at once:

pip install "patpy[dev,doc,test]"