flatspin can be installed and updated using pip:

pip install -U flatspin

If you downloaded flatspin, e.g., from GitLab, you can install it with:

pip install -U path/to/flatspin

Developers will want to install with:

pip install --user -e -U path/to/flatspin[dev]

Python version

flatspin requires Python 3.5 or later.


These packages will be installed automatically when installing flatspin

  • numpy and scipy

  • pandas

  • matplotlib

  • pyopencl

  • pillow

  • joblib

  • numba

  • tqdm

  • scikit-image

Optional dependencies

  • pytest and pytest-benchmark are needed to run the tests

  • sphinx is needed to generate the documentation