Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
XPCS Viewer 0.1.8 documentation
Logo
XPCS Viewer 0.1.8 documentation

Tutorials

  • Tutorials
    • Quick Start
    • Getting Started with XPCS Viewer
    • Mask Editor and Q-Map Tutorial
    • Fitting G2 Correlation Functions
    • Backend Selection: JAX vs NumPy
    • Cookbook: Common Patterns and Recipes

How-To Guides

  • How-To Guides
    • Installation
    • Quick Start
    • Usage
    • Mask Editor Guide
    • Examples
    • Contributing

API Reference

  • API Reference
    • xpcsviewer package
    • Backends
    • Schemas
    • I/O Facade
    • Fitting Module
    • Analysis Modules
    • SimpleMask
    • File I/O
    • Command-Line Interface
    • Plotting
    • Threading
    • Utilities
    • Constants
    • GUI Components
    • Helper Utilities

Explanation

  • Explanation
    • XPCS Data Formats and Conventions
    • G2 Correlation Function Theory
    • Two-Time Correlation Analysis
    • JAX Backend Architecture
    • Mask and Q-Map Internals
    • Performance Optimization

Architecture

  • Architecture
    • ADR-001: JAX Migration and Backend Abstraction
    • ADR-002: Migration from scipy.optimize to NLSQ 0.6.0
    • ADR-003: HDF5 Facade Pattern with Connection Pooling
    • ADR-004: Protocol-Based Backend Abstraction Layer
    • System Overview
    • Data Flow
    • XPCS Viewer Dependency Analysis and Integration Catalog
    • XPCS Viewer Dependency Diagram
    • Integration Points Catalog
    • Facade and Schema Infrastructure

Operations

  • Operations
    • Configuration Reference
    • Logging Guide
    • Performance Tuning

Project Info

  • Credits
  • History
Back to top
Copyright © 2025-2026, Miaoqi Chu & Wei Chen
Made with Sphinx and @pradyunsg's Furo