API reference

This reference is generated from the docstrings, module by module. Every public function, class and module-level constant Magνs ships appears here with its full signature, its parameters and what it returns.

This is the exhaustive view. Four other pages are usually the faster way in:

  • Numerical recipes — what the package can compute, with the code that computes it.

  • Available probability functions — the whole osc_prob_* family laid out by environment and flavor count, for when you know roughly what you want but not its name.

  • Engines and dispatch — which engine answers a call, and how the choice is made.

  • Performance — the tuned constants and the populations they were measured on.

Constants are documented where they live rather than collected into a table of their own, because each one’s docstring carries the measurement that set it — what was swept, on which workloads and what the alternatives cost.