Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Homodyne 2.23.3.dev3 documentation
Homodyne 2.23.3.dev3 documentation

User Guide

  • User Guide
    • Fundamentals
      • What is X-ray Photon Correlation Spectroscopy?
      • Analysis Modes
      • Homodyne Package Overview
      • Parameter Interpretation Guide
    • Data and Fitting
      • Loading XPCS Data
      • NLSQ Fitting Guide
      • Choosing Your Model
      • Interpreting Results
    • Advanced Topics
      • Bayesian Inference with CMC
      • Per-Angle Scaling Modes
      • Laminar Flow Analysis Guide
      • CMA-ES for Multi-Scale Problems
      • Large Dataset Handling and Streaming
      • Convergence Diagnostics
    • Practical Guides
      • YAML Configuration Reference
      • Batch Processing Multiple Datasets
      • Plotting Results
      • Performance Tuning: CPU/NUMA Optimization
    • Appendices
      • Troubleshooting Guide
      • Frequently Asked Questions
      • Glossary

Theory & Physics

  • Theory & Physics
    • Transport Coefficient J(t)
    • Correlation Functions in XPCS
    • Homodyne Scattering: Laminar Flow Model
    • Heterodyne Scattering: Multi-Component Models
    • Classical Langevin Processes
    • Yielding Dynamics of Colloidal Suspensions
    • Theoretical Framework
    • Analysis Modes
    • Per-Angle Scaling and Anti-Degeneracy
    • Anti-Degeneracy Defense System
    • Computational Methods
    • References and Citations

Configuration

  • Configuration
    • Configuration Templates
    • Configuration Options Reference

API Reference

  • API Reference
    • homodyne.core
    • homodyne.core.homodyne_model
    • homodyne.core.jax_backend
    • homodyne.core.models
    • homodyne.core.theory
    • homodyne.optimization
    • Optimization Module
    • homodyne.optimization.nlsq — Adapter
    • homodyne.optimization.nlsq — Wrapper
    • homodyne.optimization.cmc
    • homodyne.optimization.cmc.sampler
    • homodyne.optimization.cmc.reparameterization
    • homodyne.optimization.cmc.backends
    • homodyne.data
    • homodyne.config
    • homodyne CLI
    • Device Module
    • I/O Module
    • Visualization Module
    • Utilities

Examples

  • Examples

Developer Guide

  • Developer Guide
    • Contributing to Homodyne
    • Testing Guide
    • System Architecture
    • Architecture Decision Records
      • ADR-001: JAX CPU-Only Backend
      • ADR-002: NLSQ / CMC Architectural Split
      • ADR-003: Anti-Degeneracy Layer for Laminar Flow
      • ADR-004: Consensus Monte Carlo for Bayesian Inference
      • ADR-005: Per-Angle Scaling Modes
      • ADR-006: No GPU Acceleration on Consumer Hardware
    • Parameter Bounds Codebase Verification

Architecture Deep Dives

  • Architecture Deep Dives
    • Homodyne Architecture Overview
    • Homodyne Physical Model Architecture
    • Homodyne NLSQ Fitting Architecture
    • Homodyne CMC (Consensus Monte Carlo) Fitting Architecture
    • Homodyne Data Handler Architecture

Additional Resources

  • Installation
  • Quick Start — 5 Minutes to First Analysis
  • Contributing to Homodyne
Back to top
View this page
Edit this page

Examples¶

End-to-end worked examples for XPCS analysis workflows.

See Also¶

  • User Guide — structured learning guide

  • Loading XPCS Data — loading real HDF5 data

  • API Reference — full API reference

Next
Developer Guide
Previous
Utilities
Copyright © 2024–2026, Wei Chen, Hongrui He - Argonne National Laboratory
Made with Sphinx and @pradyunsg's Furo
On this page
  • Examples
    • See Also