esrf-loadfile 0.2.2

Generic loaders for ESRF useful files

esrf-loadfile

Standalone re-usable loader utilities for ESRF DCT and tomography data formats. These helpers were extracted from the StatusGUI code base so that other tools can inspect .h5, .mat, .cif, and reflection files without depending on the GUI.

Installation

pip install esrf-loadfile

Mamba environment

module load mamba  # on ESRF systems
mamba create -n esrf_loadfile -c conda-forge python pip setuptools
mamba activate esrf_loadfile
pip install esrf_loadfile

For local development inside the StatusGUI monorepo you can install it in editable mode:

pip install -e loadfile

Usage

from esrf_loadfile import loadFile

handler = loadFile("/path/to/parameters.h5")
print(handler.get_keys("entry/detector"))

# Nested keys work end-to-end:
dataset = handler.get_value("entry/detector/data")
print(handler.get_size("entry/detector/data"))
print(handler.get_description("entry/detector/data"))

# Inline dataset specs return the value directly:
dataset = loadFile("/path/to/parameters.h5::/entry/detector/data")

Inline specs are useful when you want a one-liner that returns the dataset directly.

Development

Install the project in editable mode together with its test dependencies and run the test-suite:

pip install -e .[test]
PYTHONPATH=src pytest

To run the code-coherency checks (imports/formatting/linting) install the dev extras and run Ruff on the sources:

pip install -e .[dev]
ruff check src tests