Skip to main content

A Python package for the analysis of Diffusing Wave Spectroscopy and tracer bead microrheology data.

Project description

PyPI version License Python Version

pyDWS - Expanding the reach of diffusing wave spectroscopy and tracer bead microrheology

Welcome to the repository for pyDWS, a Python package implementing the two-cell Echo diffusing wave spectroscopy (DWS) scheme.

This package provides:

  • A calibration-free method to blend and merge Echo and two-cell DWS data

  • Exponential spectrum fitting to enhance data quality, particularly at very short times

  • Stable corrections for bead and fluid inertia, significantly improving microrheology data quality at high frequencies

pyDWS is based on:

M. Helfer, C. Zhang, and F. Scheffold, "Expanding the reach of diffusing wave spectroscopy and tracer bead microrheology," arXiv:2502.14973 (2025), https://doi.org/10.1103/k34t-ghws.

Introduction

Diffusing Wave Spectroscopy (DWS) is an extension of standard dynamic light scattering (DLS), applied to soft materials that are turbid or opaque. The propagation of light is modeled using light diffusion, characterized by a light diffusion coefficient that depends on the transport mean free path l* of the medium. DWS is highly sensitive to small particle displacements or other local fluctuations in the scattering properties and can probe subnanometer displacements. Analyzing the motion of beads in a viscoelastic matrix, known as one-bead microrheology, is one of the most common applications of DWS. Despite significant advancements since its invention in 1987, including two-cell and multi-speckle DWS, challenges such as merging single and multi-speckle data and limited accuracy for short correlation times persist.

With this package, we address these key challenges in the implementation of the two-cell Echo DWS measurement scheme and propose two major improvements.

First, we introduce a calibration-free method to blend and merge Echo and two-cell DWS measurements. Second, we show that an unbiased fit of the intensity correlation function (ICF) at short times significantly improves data quality in this regime.

Building on this approach, we also demonstrate that a stable correction for bead and fluid inertia can be applied, further enhancing the reliability of microrheology data at short times.

Requirements

This package is compatible with Python ≥ 3.10 and depends on the following libraries:

  • matplotlib >= 3.4.3
  • numpy >= 1.21.0
  • pandas >= 1.3.0
  • scikit-learn >= 1.0.0
  • scipy >= 1.7.0
  • statsmodels >= 0.14.5

Installation

You can install pyDWS directly from PyPI using pip:

pip install pyDWS

Examples

We provide example workflows for wormlike micellar and microgel samples via Jupyter notebooks in the examples folder, illustrating how this package can be used.

The example datasets are available in the data folder. All measurements were performed using the following setup:
DWS Setup

From the intensity fluctuations, the correlator outputs the intensity correlation function (ICF), g₂(t) - 1.
The two-cell measurements were performed at a frequency of 13 mHz, and the echo measurements at 25 Hz, both with an amplitude of 3 Vᵣₘₛ. The actual frequency during the Echo measurement is 24.9997 Hz, which is slightly lower than the set frequency because of the inertia of the oscillator.

  • Wormlike micellar sample:

    Parameters Values
    Sample An aqueous solution of cetylpyridinium chloride and sodium salicylate (100 mM CPyCl–60 mM NaSal). The sample is mixed with polystyrene beads to a final concentration slightly below 1% by volume.
    l* 330 μm
    n_water 1.33
    λ 633 nm
    L (Cuvette thickness) 2 mm
    a (bead radius) 210 nm
    ρ_b (bead density) 1050 kg/m³ (polystyrene bead mass density)
    ρ (medium density) 1000 kg/m³ (water)
    T 20 °C
  • Microgel sample:

    Parameters Values
    Sample pNIPAM microgel in MilliQ water with 1.5 mol% crosslinker BIS
    φ ~18 wt%
    l* 157 μm
    n_water 1.33
    λ 633 nm
    L (Cuvette thickness) 5 mm
    a (bead radius) 293 nm (size of the microgel itself)
    T 28 °C

Reference

If you use pyDWS in your research, please cite:

M. Helfer, C. Zhang, and F. Scheffold,
"Expanding the reach of diffusing wave spectroscopy and tracer bead microrheology,"
Phys. Rev. Research 7, 043274 (2025).
https://doi.org/10.1103/k34t-ghws

Project details


Download files

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

Source Distribution

pydws-1.1.2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

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

pydws-1.1.2-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file pydws-1.1.2.tar.gz.

File metadata

  • Download URL: pydws-1.1.2.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pydws-1.1.2.tar.gz
Algorithm Hash digest
SHA256 a2843efcc32a7ea862517341275d43bab80c45e16d9633fe78084b56243447e7
MD5 64f80559138762f746cd6d0599c8a365
BLAKE2b-256 8be151d54c0b90ea34540d5a6cf384e0f3e22160d1715561b6e03740b6bb38e1

See more details on using hashes here.

File details

Details for the file pydws-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: pydws-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pydws-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5a0c108b2d1b3570f9b07c1a65381a89839869a7fdd10b5d94322d7d5203d903
MD5 4eb7f75f870f900403268ead9f76726f
BLAKE2b-256 110ec9c1cc9ac8a7d9b6d00b01262e7c503b3540cac6d6e73f2f10ef16de10e3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page