Tutorials

Step-by-step lessons that take you through a series of steps to complete a project. Tutorials are learning-oriented: they help you get started and build understanding.

• Quick Start
  • Launch the GUI
  • CLI Batch Processing
  • Load Data with the Python API
  • Key Shortcuts
  • Next Steps
• Getting Started with XPCS Viewer
  • Prerequisites
  • Step 1 – Load an HDF5 File
  • Step 2 – Inspect Metadata
  • Step 3 – Extract G2 Data
  • Step 4 – Plot G2 Curves
  • Step 5 – Extract SAXS 1D Data
  • Step 6 – Basic G2 Fitting
  • Step 7 – Context Manager Usage
  • Next Steps
• Mask Editor and Q-Map Tutorial
  • Overview
  • Step 1 – Initialize the Kernel
  • Step 2 – Load Detector Data
  • Step 3 – Inspect the Q-Map
  • Step 4 – Modify the Mask
  • Step 5 – Save and Load Masks
  • Step 6 – Recompute Q-Map
  • Step 7 – Compute a Q-Phi Partition
  • Step 8 – Validate with Schemas
  • GUI Workflow
  • Next Steps
• Fitting G2 Correlation Functions
  • Overview of the Fitting Pipeline
  • Physical Models
  • Part 1: NLSQ Fitting
  • Part 2: Bayesian Fitting
  • Part 3: Fitting from XpcsFile
  • Model Comparison
  • Next Steps
• Backend Selection: JAX vs NumPy
  • Architecture Overview
  • Checking the Active Backend
  • Switching Backends
  • Using the Backend API
  • I/O Boundary Conversions
  • When to Use Each Backend
  • Troubleshooting
  • Next Steps
• Cookbook: Common Patterns and Recipes
  • Loading Multiple Files
  • Comparing G2 Across Files
  • Batch Fitting with NLSQ
  • Tau vs Q Analysis (Diffusion)
  • Reading G2 Data with HDF5Facade
  • Creating G2Data from Arrays
  • Backend-Aware Computation
  • Exporting Results to CSV
  • Two-Time Correlation Analysis
  • Memory-Efficient Processing
  • Custom Model Functions
  • Logging Configuration

Tip

New to xpcsviewer? Start with Quick Start for a 5-minute overview, then work through Getting Started with XPCS Viewer for a guided walkthrough of loading data, inspecting metadata, and plotting your first G2 curve.