Caveats & contributing

Status

This is an alpha release. Pin a version when reproducibility matters. Hierarchical calibration covers a subset of input conditions; unsupported requests require additional measurements or explicit coarse parameters.

Wheels target CPython 3.10–3.14 on Linux x86-64 and macOS arm64. Other platforms build from source and need NumPy and a C compiler. CPU filtering uses one thread; callers control parallelism across independent filters.

Contributing

Issues and pull requests are welcome. Useful contributions include device-specific benchmarks, calibration measurements and testing on additional hardware.

git clone https://github.com/ahnitz/matchedfilter
cd matchedfilter
git submodule update --init third_party/highway
pip install -e .
pytest

GPU kernels are written in Slang. Rebuild the shipped SPIR-V and Metal sources with python tools/build_spirv.py --slangc /path/to/slangc. The tooling map identifies benchmark, calibration and historical research scripts. The performance checks include opt-in timing gates and comparison with a saved baseline.