Contributing to viscy

Development installation

Clone or fork the repository, then make an editable installation with all the development dependencies:

# in project root directory (parent folder of pyproject.toml)
pip install -e ".[dev]"

Install pre-commit hooks to automatically check and format code before commits:

pre-commit install

To run pre-commit checks manually:

# Run on staged files only
pre-commit run

Lint and format with Ruff:

ruff check viscy
ruff format viscy tests

Run tests with pytest:

pytest -v