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.

  1. Install conda following the instructions at link.

  2. Create a brand-new environment with conda:

    conda create -n your_env_name python==3.10.16

    Replace your_env_name with your preferred environment name.

  3. Activate the new environment:

    conda activate your_env_name

  4. Install pyXPCSViewer:

    pip install xpcs-viewer

    Note: Running conda and pip commands together is generally not recommended. pyXPCSViewer will only use pip or conda once compatibility issues are resolved.

  5. Launch pyXPCSViewer:

    1. Activate your environment if you have not already.

    2. 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.

  6. To upgrade:

    1. Activate your environment if you have not already.

    2. Run:

      pip install -U xpcs-viewer

  7. To uninstall:

    1. Activate your environment if you have not already.

    2. Run:

      pip uninstall xpcs-viewer

    3. If you want to remove the environment altogether, first deactivate it:

      conda deactivate

      Then remove it:

      conda remove -n your_env_name --all

Gallery

  1. The integrated scattering pattern over the whole time series.

    docs/images/saxs2d.png

  2. The reduced one-dimensional small-angle scattering data.

    docs/images/saxs1d.png

  3. 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.

    docs/images/stability.png

  4. Intensity fluctuation vs. Time.

    docs/images/intt.png

  5. Average Tool box.

    docs/images/average.png

  6. 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).

    docs/images/g2mod.png

  7. Diffusion analysis. g2 fitting in the previous panel is required to plot \(\tau \mbox{vs.} q\).

    docs/images/diffusion.png

  8. Two-time correlation. Users can select two q indexes either on the q-map or on the SAXS-2D image.

    docs/images/twotime.png

  9. Experiment condition viewer. It reads the file structure and string entries of the selected HDF file.

    docs/images/hdf_info.png

License

Copyright © 2026 UChicago Argonne, LLC. Licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.2.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mqichu from gravatar.com mqichu

Credits

Author/Maintainer: Miaoqi Chu

License

Apache Software License (Apache-2.0)

Provides Extra

dev docs pyinstaller

Tags

XPCS X-ray photon correlation spectroscopy synchrotron visualization science

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xpcs_viewer-1.2.1.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xpcs_viewer-1.2.1-py3-none-any.whl (147.2 kB view details)

Uploaded Python 3

File details

Details for the file xpcs_viewer-1.2.1.tar.gz.

File metadata

  • Download URL: xpcs_viewer-1.2.1.tar.gz
  • Upload date:
  • Size: 10.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for xpcs_viewer-1.2.1.tar.gz
Algorithm Hash digest
SHA256 f48628f6e2a6123a22e734b1eb62d45987b0a71dc3a1120ab06095047613c78a
MD5 583ef98b8098daaeadc68128738e2924
BLAKE2b-256 3be74e2abdc1ab9e25b86a2c7fbee2f44df1085990f68253a7e8aea092fa972d

See more details on using hashes here.

Provenance

The following attestation bundles were made for xpcs_viewer-1.2.1.tar.gz:

Publisher: publish-pypi.yml on AdvancedPhotonSource/pyXpcsViewer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xpcs_viewer-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: xpcs_viewer-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 147.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for xpcs_viewer-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b11632bb9497a04b0600512a110b1c71c91235dd151ea2a2a33ef353a2f846dd
MD5 8638eca43e89dc8a701c41df00c30cd5
BLAKE2b-256 188e0bf19ed04952925321fe92137fdbebe3455514dafe68c2e7398bf0542feb

See more details on using hashes here.

Provenance

The following attestation bundles were made for xpcs_viewer-1.2.1-py3-none-any.whl:

Publisher: publish-pypi.yml on AdvancedPhotonSource/pyXpcsViewer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.2.2

2 files

This release

1.2.1 This release

2 files

1.2.0

2 files

1.1.0

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.0

2 files

0.260

2 files

0.259

2 files

0.258

2 files

0.257

2 files

0.256

2 files

0.255

2 files

0.253

2 files

0.251

2 files

0.250

2 files

0.249

2 files

0.248

2 files

0.247

2 files

0.246

2 files

0.244

2 files

0.243

2 files

0.242

2 files

0.241

2 files

0.240

2 files

0.239

2 files

0.238

2 files

0.237

2 files

0.236

2 files

0.235

2 files

0.234

2 files

0.233

2 files

0.232

2 files

0.231

2 files

0.230

2 files

0.229

2 files

0.228

2 files

0.227

2 files

0.226

2 files

0.225

2 files

0.224

2 files

0.223

2 files

0.222

2 files

0.221

2 files

0.219

2 files

0.218

2 files

0.217

2 files

0.215

2 files

0.214

2 files

0.213

2 files

0.212

2 files

0.211

2 files

0.209

2 files

0.207

2 files

0.206

2 files

0.205

2 files

0.204

2 files

0.203

2 files

0.202

2 files

0.201

2 files

0.2

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page