Contribute

Contributing¶

quantEM is developed openly at github.com/electronmicroscopy/quantem. Bug reports, feature requests, and pull requests are welcome through GitHub issues and PRs.

Development setup¶

Development uses uv:

git clone https://github.com/electronmicroscopy/quantem.git
cd quantem
uv sync

Linting and formatting use ruff via pre-commit:

uv tool install pre-commit
uv tool install ruff
pre-commit install

Tests run with pytest:

uv run pytest

The complete developer guide (widget development, dependency management, environment activation) is in CONTRIBUTORS.md.

Contributing to the documentation¶

This site is written in MyST Markdown and lives in the quantem-docs repository. To preview changes locally:

npm install -g mystmd
myst start

Tutorial notebooks live in quantem-tutorials.