Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
xpcsjax 0.1.6
xpcsjax 0.1.6

Getting started

  • Installation
  • Quickstart

User guide

  • User guide
    • Overview
    • Data loading
    • Configuration
    • Analysis modes
    • Homodyne workflow
    • Heterodyne workflow
    • NLSQ fitting
    • Interpreting results
    • Visualization
    • Command-line interface
    • Analysis workbench (GUI)
    • Troubleshooting

Theory

  • Theory and physics
    • XPCS Basics
    • Correlation Functions in XPCS
    • Homodyne Model
    • Heterodyne Model
    • Transport Coefficient J(t)
    • Anti-Degeneracy Defence
    • Heterodyne Anti-Degeneracy System (4 layers)
    • Heterodyne Memory Strategy and Angle Stratification
    • References and Citations

Examples

  • Examples
    • Basic Homodyne Fit (Static Isotropic)
    • Laminar Flow Fit (7 Parameters)
    • Heterodyne Multi-angle Fit (two_component mode)
    • Robust Multi-start Fitting

API reference

  • API reference
    • Public API
    • xpcsjax.data
    • xpcsjax.config
    • xpcsjax.core
    • xpcsjax.optimization.nlsq
    • xpcsjax.optimization.nlsq.results
    • Visualization (xpcsjax.viz)
    • xpcsjax.cli
    • xpcsjax.runtime
    • xpcsjax.service
    • xpcsjax.device
    • xpcsjax.io
    • xpcsjax.utils

Advanced topics

  • Advanced topics
    • Architecture Overview
    • JAX Environment Setup
    • Lazy Public API
    • Memory Routing
    • Anti-degeneracy Controller
    • CMA-ES Escape

Development

  • Development
    • Contributing
    • Testing
    • Releasing
    • Porting Notes
    • NLSQ Integration
    • Decision record: CPU-only execution, GPU deferred

Project

  • Changelog
Back to top
View this page
Edit this page

ExamplesΒΆ

Runnable, end-to-end examples that cover the common xpcsjax workflows. Each example is built around the two-function public API and the YAML configuration schema.

  • Basic Homodyne Fit (Static Isotropic)
  • Laminar Flow Fit (7 Parameters)
  • Heterodyne Multi-angle Fit (two_component mode)
  • Robust Multi-start Fitting
Next
Basic Homodyne Fit (Static Isotropic)
Previous
References and Citations
Copyright © 2026, Wei Chen (Argonne National Laboratory)
Made with Furo