Skip to main content

Multi-Modal Analysis

This repository contains a Python script designed for the analysis of multimodal in-situ data taken at beamline 12.3.2 of the Advanced Lightsource (ALS). The script performs various data processing tasks including timestamp-adjustment, data selection, detector-geometry calibration, diffraction data integration, peak fitting, and various ways of data visualization. It uses in-situ photoluminescence (PL) and (grazing incidence) wide-angle X-ray scattering (GI-WAXS) data as well as logged process parameters as input. MMAnalysis will ask for the GI-WAXS calibration first, which should be done with the pyFAI-GUI unless a local .poni was created before. After the calibration, MMA is going to ask for the calibration.poni file as well as the in situ run files (*.h5).

Requirements

Check the file requirements.txt to see which packages are needed. Installing the package using pip should already take care of all dependencies.

Installation instructions

Create a new virtual environment

Create a new Python environment. (You can also do it in a pre-existing environment, but make sure you don't break something):

conda create -n mmanalysis python=3.11
conda activate mmanalysis

Note that you may need to initialize your shell within conda, e.g., using conda init bash. You will know if the conda environment has been activated when you see that your shell prompt is modified with (mmanalysis).

After activating your new (or existing) environment, follow the next steps.

Install using pip

You can simply install the latest release of the package and all dependencies using:

pip install mmanalysis

Install directly the source code

Alternatively you can obtain mmanalysis directly from the repository by following those steps:

Clone the repository in the desired location:

git clone https://github.com/sutterfellalab/MultiModalAnalysis.git

Install the package and its dependencies with pip:

cd MultiModalAnalysis
pip install .

GPU acceleration through OpenCL is optional:

pip install ".[gpu]"

Features

  • Logging Data Selection: Automatically suggests start times and plots raw and post-processed log data.
  • GIWAXS Data Selection: Automatically finds suggested start times, plots raw and post-processed GIWAXS data, and performs peak fitting. Additionally, it gives an option to extract individual frames for x-y-plots.
  • PL Data Selection: Plots raw and post-processed PL data (PL data have the same timestamp as the logging data), optimizes data for plotting, and performs peak fitting. Additionally, it gives an option to extract individual frames for x-y-plots.
  • Stacked Plots: Generates stacked plots for combined GIWAXS, PL, and logging data.
  • **Output: the script creates a new "output" folder containing all the images displayed during execution as well as all relevant data in .csv files

Contact

Feel free to create Merge Requests and Issues on our GitHub page: https://github.com/sutterfellalab/MultiModalAnalysis.

If you want to contact the authors, please write to T. Kodalle at TimKodalle@lbl.gov.

Metadata

Release files for mmanalysis 1.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mmanalysis 1.0.7
File Size Uploaded Provenance Actions
mmanalysis-1.0.7.tar.gz 749.5 kB With provenance Details for mmanalysis-1.0.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mmanalysis 1.0.7
File Interpreter ABI Platform Actions
mmanalysis-1.0.7-py3-none-any.whl Python 3 none any Details for mmanalysis-1.0.7-py3-none-any.whl

Total release size: 1.5 MB

Release files / mmanalysis-1.0.7.tar.gz

Download URL mmanalysis-1.0.7.tar.gz
Size 749.5 kB
Tags Source
SHA-256 checksum
How to use checksums
e0366059cea9b472809ef9403f71b2b47f1f6c8fbba45056b54a49820a6fc2b7
BLAKE2b-256 checksum
How to use checksums
e50ca8dd1d337a005cea676410e9f58c4da0b1560abe385b14a643c70944ff85
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 Sep 18, 2026.

Transparency log

Release files / mmanalysis-1.0.7-py3-none-any.whl

Download URL mmanalysis-1.0.7-py3-none-any.whl
Size 799.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
81294a44987c5c9c4c598416a40db1dd96cbfa07c2228f7b39dfebcdc5577eae
BLAKE2b-256 checksum
How to use checksums
4b32f0fb404cacddb82dad634da16af578e97c9b34f34cb42b2f939cc4eca825
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 Sep 18, 2026.

Transparency log

Security for mmanalysis 1.0.7

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

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mmanalysis-1.0.7.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 Sep 18, 2026.

Transparency log

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

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