Skip to main content

GUI app for automated batch processing of Lambda detector data with Dioptas

Project description

Dioptas Batch Processor GUI

Standalone GUI for automated batch processing of Lambda detector diffraction files using Dioptas.

Features

  • Folder watch mode for automatic processing of incoming .nxs / .h5 files
  • Manual batch mode for selected files
  • CHI export (1D integration)
  • NPY export (2D cake arrays: intensity, two-theta, azimuth)
  • Optional mask support
  • Background processing thread to keep GUI responsive

Project Structure

dioptas_batch_gui/
├── dioptas_batch_gui/
│   ├── __init__.py
│   ├── __main__.py
│   ├── version.py
│   ├── gui.py
│   ├── batch_processor.py
│   └── file_watcher.py
├── check_dependencies.py
├── pyproject.toml
├── requirements.txt
├── LICENSE
├── CHANGELOG.md
├── CONTRIBUTING.md
└── SECURITY.md

Requirements

  • Python 3.10+
  • conda (recommended for environment management)

Installation (Recommended)

Set up in this order:

  1. Create and activate a conda environment named dioptas.
conda create -n dioptas python=3.10 -y
conda activate dioptas
  1. Install Dioptas first inside that environment.
pip install dioptas
  1. Install this package.
pip install dioptas-batch-gui

Update to the latest PyPI release

pip install --upgrade dioptas-batch-gui

Force reinstall from PyPI

pip install --upgrade --force-reinstall dioptas-batch-gui

Verify Dependencies

python check_dependencies.py

Usage

Installed CLI commands (work from any directory once your environment is active in terminal or console):

After:

conda activate dioptas
dbgui

or

dioptas_batch_gui

or

dioptas-batch-gui

For a local checkout, you can also launch the app directly:

python -m dioptas_batch_gui

Basic Workflow

  1. Set Watch Directory or switch to Batch Mode and select files manually.
  2. Set Output Directory.
  3. Select the Calibration File (.poni).
  4. Optionally select a Mask File.
  5. Configure integration points and azimuth bins.
  6. Choose the export options you want.
  7. Click Start Watching for automatic mode or Process Selected Files for manual batch mode.
  8. Click Stop Watching when finished with auto-processing.

Output

For each processed dataset, the app exports:

  • <base_name>.chi
  • <base_name>-param/<base_name>.int.cake.npy
  • <base_name>-param/<base_name>.tth.cake.npy
  • <base_name>-param/<base_name>.azi.cake.npy

For HDF5/NXS files containing multiple snapshot images, outputs use a one-based snapshot suffix in the output stem and parameter directory name. When the input stem ends in a numeric scan/index segment, the snapshot suffix is inserted before that final segment:

  • xxx_map_1_0001.h5 snapshot 1: xxx_map_1_001_0001.chi
  • xxx_map_1_0001.h5 snapshot 2: xxx_map_1_002_0001.chi
  • xxx_map_1_001_0001-param/xxx_map_1_001_0001.int.cake.npy

Output layout:

output_directory/
├── <base_name>.chi
└── <base_name>-param/
    ├── <base_name>.int.cake.npy
    ├── <base_name>.tth.cake.npy
    ├── <base_name>.azi.cake.npy
    └── <calibration>.poni

License

GPL-3.0-only. See LICENSE.

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

dioptas_batch_gui-0.2.0.tar.gz (769.8 kB view details)

Uploaded Source

Built Distribution

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

dioptas_batch_gui-0.2.0-py3-none-any.whl (767.5 kB view details)

Uploaded Python 3

File details

Details for the file dioptas_batch_gui-0.2.0.tar.gz.

File metadata

  • Download URL: dioptas_batch_gui-0.2.0.tar.gz
  • Upload date:
  • Size: 769.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for dioptas_batch_gui-0.2.0.tar.gz
Algorithm Hash digest
SHA256 636fffeef0df65eb9a5c2b83fb3901619e80c3f217c14748adb2d9c9a0277a8c
MD5 dac382156b6e54122e1c01f688ce3479
BLAKE2b-256 1e16b2a1a3736c8331765c3d8d42b65092939df4d15f327bb5f21acb0c772971

See more details on using hashes here.

File details

Details for the file dioptas_batch_gui-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dioptas_batch_gui-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c07108049b05cdf6bb39fd0d80bc00e591b55bde9e5e302b941c4055a60caf8
MD5 e2d5386519db569c4fbfaf9accd534ce
BLAKE2b-256 2a103859565ef735de1c4d6a36154c8695319a95ba8bd7381022bd0a24bfb70c

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