User Guide

This guide covers the full workflow for analysing two-component heterodyne XPCS data with the heterodyne package, from loading raw correlation matrices to interpreting Bayesian posteriors.

Tip

Choose a learning pathway below based on your background and goals. Each pathway lists pages in the recommended reading order.

Learning Pathways

Path A – New to XPCS

Start with the physics, then walk through a complete analysis.

  1. What Is XPCS?

  2. Heterodyne Package Overview

  3. Data Loading

  4. NLSQ Fitting

  5. Result Interpretation

  6. Parameter Guide

Path B – Two-Component Dynamics

You know X-ray scattering but want to understand the heterodyne two-component model in depth.

  1. What Is XPCS?

  2. Heterodyne Package Overview

  3. Per-Angle Scaling

  4. Bayesian Inference

  5. Troubleshooting

  6. Parameter Guide

Path C – Bayesian Uncertainty Quantification

You are comfortable with the model and want to move from point estimates to full posteriors.

  1. NLSQ Fitting

  2. Bayesian Inference

  3. Diagnostics and Convergence

  4. Result Interpretation

  5. Visualization

Path D – Advanced / Performance

Optimise configurations, tune performance, and explore global optimisation.

  1. Configuration

  2. Performance Tuning

  3. CMA-ES Global Optimisation

  4. Parameter Guide

  5. Diagnostics and Convergence

Guide Contents