Installation#

Requirements#

PyFlowReg requires Python 3.10 or higher.

The recommended installation method is via pip:

pip install pyflowreg

To install with full visualization support (matplotlib, scikit-learn):

pip install pyflowreg[vis]

Session processing support is included in the base install. The session CLI pyflowreg-session is installed with pip install pyflowreg.

For all optional features (visualization, cluster computing, and GPU backends):

pip install pyflowreg[vis,dask,gpu]

To install in development mode with test dependencies:

git clone https://github.com/FlowRegSuite/pyflowreg.git
cd pyflowreg
pip install -e .[test,vis,docs]

On Windows, MDF file support (Sutter file format) requires additional dependencies:

pip install pywin32

This is automatically installed when using pip install pyflowreg on Windows.

Create a dedicated environment with mamba:

mamba create --name pyflowreg python=3.10
mamba activate pyflowreg
pip install pyflowreg

Test your installation:

import pyflowreg
from pyflowreg.motion_correction import OFOptions
from pyflowreg.session import SessionConfig
print(pyflowreg.__version__)

Verify command-line tools:

# Check session CLI is installed
pyflowreg-session --help