API Reference¶

Complete API documentation for the heterodyne XPCS analysis package. All public modules, classes, and functions are documented with full type signatures and cross-references.

Quick Navigation¶

Module	Description
Core Physics	Physics constants, safe numerics, and integral primitives
Heterodyne Model	Main `HeterodyneModel` wrapper with `ParameterManager`
JAX Backend	JAX/JIT meshgrid correlation computation
Model Hierarchy	Model hierarchy: base, two-component, reduced, and factory
NLSQ Optimization	Non-linear least squares optimization (scipy + JAX JIT)
CMC (Bayesian)	Bayesian MCMC via NumPyro (NUTS / CMC)
Data	XPCS data loading, validation, and preprocessing
Configuration	Configuration management, parameter registry, and parameter space
CLI	Command-line interface entry points and runners
Device Management	Hardware detection and CPU/NUMA configuration
I/O Utilities	Result serialization (JSON, NPZ, MCMC diagnostics)
Visualization	MCMC and NLSQ visualization, dashboards, and reports
Utilities	Logging configuration and path validation utilities

Core Physics¶

Foundational physics constants, numerical primitives, and correlation models.

Optimization¶

NLSQ warm-start and Bayesian posterior sampling pipelines.

Optimization
- NLSQ Optimization
- CMC (Bayesian)

Infrastructure¶

Data I/O, configuration, CLI, device management, visualization, and utilities.