pyFFS 2.2.0

Installation

$ pip install pyFFS

Developer Install

Recommended setup using Anaconda, for optimized numerical libraries:

# Create Anaconda environment
$ conda create --name pyffs python=3
$ conda activate pyffs

# Clone repository
$ git clone https://github.com/imagingofthings/pyFFS.git
$ cd pyFFS
$ # git checkout <commit>

# Install requirements with conda
$ conda install --file requirements.txt

# Optionally install CuPy for GPU support
$ conda install -c conda-forge cupy

# Install pyFFS
$ pip install -e .[dev]
$ pytest                        # Run test suite
$ python setup.py build_sphinx  # Generate documentation

More information about CuPy setup can be found here.

Remarks

pyFFS is developed and tested on x86_64 systems running Linux and macOS Catalina.