Developer guide

Developer guide#

Building, testing, documenting and contributing. AGENTS.md at the repository root records the design rules of the native library and the operator layer.

Page

Contents

Development installation

Toolchain, source builds, FINUFFT backends, editable install, pre-commit hooks

Development workflow

Checks, pull requests and CI, generated files, submodule updates, code of conduct

Coding style

Python, C and docstring conventions

Documentation

Documentation types, scientific writing, docstrings

Terminology and conventions

Vocabulary and conventions of code and documentation

Internals

Rules, derivations and measurements behind the explanation pages

Repository layout

Directories of the repository and modules of the package

BART fork

Downstream BART fork: branches, patch scope, synchronisation with Codeberg