A python-based interactive visualization tool to view XPCS dataset.
To cite pyXPCSViewer:
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.
Supported Format
This tools supports the customized nexus fileformat developed at APS-8IDI’s XPCS data format for both multi-tau and two-time correlation.
Install and Uninstall
Updated 03/11/2025
It is highly recommended to set up a new virtual environment to isolate pyXPCSViewer, so it does not interfere with dependencies of your existing applications.
Install conda following the instructions at link.
Create a brand-new environment with conda:
conda create -n your_env_name python==3.10.16Replace your_env_name with your preferred environment name.
Activate the new environment:
conda activate your_env_nameInstall pyXPCSViewer:
pip install xpcs-viewerNote: Running conda and pip commands together is generally not recommended. pyXPCSViewer will only use pip or conda once compatibility issues are resolved.
Launch pyXPCSViewer:
Activate your environment if you have not already.
Run:
pyxpcsviewer path_to_hdf_directory # Run the viewer from the hdf directory pyxpcsviewer # Run in the current directory
run_viewer, an alias to pyxpcsviewer, can also be used to luanch the viewer.
To upgrade:
Activate your environment if you have not already.
Run:
pip install -U xpcs-viewer
To uninstall:
Activate your environment if you have not already.
Run:
pip uninstall xpcs-viewerIf you want to remove the environment altogether, first deactivate it:
conda deactivateThen remove it:
conda remove -n your_env_name --all
Gallery
The integrated scattering pattern over the whole time series.
The reduced one-dimensional small-angle scattering data.
The sample’s stability against X-ray beam damage. The time series is divided into 10 sections. The SAXS-1D curve is plotted for each section.
Intensity fluctuation vs. Time.
Average Tool box.
g2 plot for multitau analysis. Users can fit the time scale using a single exponential function, with options to specify the fitting range and fitting flags (fix or fit).
Diffusion analysis. g2 fitting in the previous panel is required to plot \(\tau \mbox{vs.} q\).
Two-time correlation. Users can select two q indexes either on the q-map or on the SAXS-2D image.
Experiment condition viewer. It reads the file structure and string entries of the selected HDF file.
License
Copyright © 2026 UChicago Argonne, LLC. Licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
1 maintainer
Metadata
1 maintainer
Release files for xpcs-viewer 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| xpcs_viewer-1.2.2.tar.gz | 10.1 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xpcs_viewer-1.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.3 MB
Release files / xpcs_viewer-1.2.2.tar.gz
| Download URL | xpcs_viewer-1.2.2.tar.gz |
|---|---|
| Size | 10.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4478038f7320c94c300516722b05483da509d5f566e84112747e68a26ffeb9cc
|
|
BLAKE2b-256 checksum How to use checksums |
897f3306989f796c2649250c94763a7aaa05d11b0cb857e061c710b42ff40a6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logRelease files / xpcs_viewer-1.2.2-py3-none-any.whl
| Download URL | xpcs_viewer-1.2.2-py3-none-any.whl |
|---|---|
| Size | 207.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
edc1a1cb94f25d123a4934eaa6d14e9fb41875c8ec0db31c49b9eba4ef142983
|
|
BLAKE2b-256 checksum How to use checksums |
d81791d68888a7c70aa5942d790e3ab61f4bd3706433aeec1d55faf8a054df3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logSecurity for xpcs-viewer 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for xpcs_viewer-1.2.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
