How-To Guides

Practical step-by-step guides for accomplishing specific tasks. How-to guides are task-oriented: they help you solve a real-world problem.

• Installation
  • Requirements
  • Install
  • GPU Acceleration (Optional)
  • Development Install
  • Verify
• Quick Start
  • Launch the GUI
  • CLI Batch Processing
  • Load Data (Python API)
  • See Also
• Usage
  • Command-Line Entry Points
  • GUI Usage
  • CLI Usage
  • Python API
  • Configuration
• Mask Editor Guide
  • Launching the Mask Editor
  • Drawing Tools
  • Creating Masks
  • Saving and Loading Masks
  • Geometry Parameters
  • Q-Map Generation
  • Q-Binning (Partition)
  • Exporting to XPCS Viewer
  • Keyboard Shortcuts
  • Troubleshooting
  • See Also
• Examples
  • G2 Analysis
  • SAXS Processing
  • Batch Processing
• Contributing
  • Types of Contributions
  • Development Setup
  • Pull Request Guidelines
  • Code Standards

Note

More how-to guides are planned, including:

• Batch processing with the CLI

• Creating custom masks for different detector geometries

• Exporting publication-quality figures

• Configuring JAX backend acceleration