# API Reference

This section documents the **reusable library code** in `mathxlab` (the parts you would import and build upon).

:::{admonition} Public API only
:class: note

These pages aim to document only the public surface.

- If a module defines `__all__`, the docs follow it.
- Otherwise, "public" means "not starting with `_`".

If you want strict control, add `__all__ = [...]` to each public module.
:::

::::{only} html
:::{grid} 2
:gutter: 2

:::{grid-item-card} Experiment framework
:link: exp
:link-type: doc

`mathxlab.exp` — CLI helpers, seeding, logging, and report writing.
:::

:::{grid-item-card} Experiment registry
:link: experiments
:link-type: doc

`mathxlab.experiments` — stable registry for enumerating experiments.
:::

:::{grid-item-card} Number theory
:link: nt
:link-type: doc

`mathxlab.nt` — arithmetic, Dirichlet machinery, and zeta/L-related utilities.
:::

:::{grid-item-card} Numerics
:link: num
:link-type: doc

`mathxlab.num` — numerical series helpers.
:::

:::{grid-item-card} Plotting
:link: plots
:link-type: doc

`mathxlab.plots` — plotting helpers used across experiments and reports.
:::

:::{grid-item-card} Utilities
:link: utils
:link-type: doc

`mathxlab.utils` — shared utilities.
:::

:::{grid-item-card} Visualization backends
:link: viz
:link-type: doc

`mathxlab.viz` — visualization backend wrappers (Matplotlib).
:::
:::
::::

::::{only} latex
- **Experiment framework** (`mathxlab.exp`)
  CLI helpers, seeding, logging, and report writing.

- **Experiment registry** (`mathxlab.experiments`)
  Stable registry for enumerating experiments.

- **Number theory** (`mathxlab.nt`)
  Arithmetic, Dirichlet machinery, and zeta/L-related utilities.

- **Numerics** (`mathxlab.num`)
  Numerical series helpers.

- **Plotting** (`mathxlab.plots`)
  Plotting helpers used across experiments and reports.

- **Utilities** (`mathxlab.utils`)
  Shared utilities.

- **Visualization backends** (`mathxlab.viz`)
  Visualization backend wrappers (Matplotlib).
::::

:::{toctree}
:hidden:
:maxdepth: 2

exp
experiments
nt
num
plots
utils
viz
:::