README.md

simtk: structured illumination microscopy image reconstruction

Open source structured illumination microscopy image reconstruction in an easy-to-use, performant, and extensible package.

Installation

pip install simtk

Hacking

Contributions are welcome and appreciated.

To set up a development build::

git clone https://github.com/sim-reconstruction/simtk
cd simtk

# Install dependencies
pip install -r requirements.txt -r requirements-dev.txt

# Run tests
pytest tests/ -v --benchmark-autosave --cov=simtk

This project uses the black code formatter for a consistent coding style. To apply the formatter:

black simtk/* tests/*