xpcsviewer-gui 0.1.2

XPCS Viewer: A python-based interactive tool to visualize and model XPCS dataset

Python-based XPCS data analysis and visualization tool.

Features:

• G2 correlation analysis with fitting

• SAXS 1D/2D visualization

• Two-time correlation analysis

• Mask Editor with Q-map and Q-binning

• HDF5 data support (NeXus format)

GUI Features:

• Light/dark theme support with system detection

• Session persistence (resume where you left off)

• Command palette (Ctrl+Shift+P) for quick access

• Toast notifications for status updates

• Keyboard shortcut management

• Drag-and-drop file handling

• Theme-aware plots (PyQtGraph & Matplotlib)

UI notes

• Menu-driven header (no quick-access toolbar); all actions live under the menus/shortcuts.

• Starts maximized with a rectangular layout and a minimum-size floor to prevent cramped controls.

• PySide6 GUI interface with modern theming

• Performance optimizations

Installation

Requirements: Python 3.12+

# Basic installation
pip install xpcsviewer

# Complete installation with all features and tools
pip install xpcsviewer[all]

# Install with specific optional dependencies
pip install xpcsviewer[dev]        # Development tools
pip install xpcsviewer[docs]       # Documentation building
pip install xpcsviewer[validation] # Profiling and validation tools
pip install xpcsviewer[performance] # Performance analysis tools

Usage

GUI (Interactive):

# Launch GUI with data path
xpcsviewer-gui /path/to/hdf/data

# Launch from current directory
xpcsviewer-gui

# With debug logging
xpcsviewer-gui --log-level DEBUG

CLI (Batch Processing):

# Show available commands
xpcsviewer --help

# Generate twotime plots for all phi angles at q=0.05
xpcsviewer twotime --input /data --output /results --q 0.05

# Generate high-resolution PDF plots
xpcsviewer twotime -i /data -o /results --phi 45 --dpi 300 --format pdf

Citation

Chu et al., “pyXPCSviewer: an open-source interactive tool for X-ray photon correlation spectroscopy visualization and analysis”, Journal of Synchrotron Radiation, (2022) 29, 1122–1129.

Development

# Clone and install
git clone https://github.com/imewei/XPCSViewer.git
cd XPCSViewer
pip install -e .[dev]

# Run tests
make test

# Build docs
make docs

Data Formats

• NeXus HDF5 (APS-8IDI beamline)

• SAXS 2D/1D data

• G2 correlation functions

• Time series data

Testing

make test              # Run tests
make test-unit         # Unit tests
make test-integration  # Integration tests
make coverage          # Coverage report

Documentation

• API Reference

• User Guide

• Quick Start

make docs              # Build docs
make docs-autobuild    # Live reload docs

Configuration

Environment variables for customization:

Variable	Description	Default
XPCS_LOG_LEVEL	Logging verbosity (DEBUG, INFO, WARNING, ERROR)	INFO
XPCS_CACHE_SIZE_MB	Maximum cache size in MB	512
XPCS_THEME	UI theme (light, dark, system)	system

Project Structure

xpcsviewer/
├── module/            # Analysis modules
├── fileIO/            # HDF5 I/O
├── simplemask/        # Mask editor & Q-map
├── gui/               # GUI modernization
│   ├── theme/         # Light/dark theming
│   ├── state/         # Session & preferences
│   ├── shortcuts/     # Keyboard shortcuts
│   └── widgets/       # Modern UI widgets
├── plothandler/       # Theme-aware plotting
├── threading/         # Async workers
├── utils/             # Utilities
└── xpcs_file.py       # Core data class

Analysis Features

• Multi-tau G2 correlation with fitting

• Two-time correlation analysis

• SAXS 2D pattern visualization

• SAXS 1D radial averaging

• Sample stability monitoring

• File averaging tools

• Mask editing with drawing tools (Rectangle, Circle, Polygon, Line, Ellipse)

• Q-map generation from detector geometry

• Q-binning (partition) for XPCS analysis

Gallery

Analysis Modules Showcase

1. Integrated 2D Scattering Pattern

   

2. 1D SAXS Reduction and Analysis

   

3. Sample Stability Assessment

   

4. Intensity vs Time Series

   

5. File Averaging Toolbox

   

6. G2 Correlation Analysis

   

7. Diffusion Characterization

   

8. Two-time Correlation Maps

   

9. HDF5 Metadata Explorer

   

License

MIT License. See CONTRIBUTING.rst for development guidelines.