midas-zipper

Standalone zarr-zip generation for MIDAS FF/PF workflows.

pip install midas-zipper works with no MIDAS source tree and no compiled C binaries — it depends only on numpy, h5py, zarr, numcodecs, numba, and pillow, plus the system zip/bzip2 tools.

It packages the zarr ingest that the FF and PF pipelines need to turn raw detector data (HDF5/GE/TIFF) into the *.MIDAS.zip files the rest of MIDAS consumes — previously the source-tree script utils/ffGenerateZipRefactor.py, which broke pip-only installs because it lived outside any package.

Notebooks

Worked-example Jupyter notebooks live in notebooks/. They are not shipped with pip install — get them by cloning the MIDAS repository.

CLI

# FF zarr-zip generation (formerly ffGenerateZipRefactor.py)
midas-ff-zip -resultFolder <dir> -paramFN <params.txt> -LayerNr <n>

# Update a key inside an existing Zarr.zip
midas-update-zarr -fn <file.MIDAS.zip> -keyToUpdate <key> -updatedValue <...>

Both are also runnable as modules:

python -m midas_zipper.ff_zip   -resultFolder ... -paramFN ... -LayerNr ...
python -m midas_zipper.update_zarr -fn ... -keyToUpdate ... -updatedValue ...

Python API

from midas_zipper import generate_ff_zip

generate_ff_zip(
    result_folder="/path/to/scan",
    param_file="/path/to/Parameters.txt",
    layer_nr=1,
)

Scope

This package intentionally excludes AutoCalibrateZarr.py: that tool drives the C/OpenMP calibration binaries (CalibrantPanelShiftsOMP, CalibrantIntegratorOMP, GetHKLList) and so cannot be pip-portable. It stays with the calibration workflow.

Development Status
- 4 - Beta
Intended Audience
- Science/Research
Operating System
- OS Independent
Programming Language
- Python :: 3
Topic
- Scientific/Engineering :: Physics

Download files

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

Source Distribution

midas_zipper-0.2.1.tar.gz (38.1 kB view details)

Uploaded Aug 20, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

midas_zipper-0.2.1-py3-none-any.whl (34.2 kB view details)

Uploaded Aug 20, 2026 Python 3

File details

Details for the file midas_zipper-0.2.1.tar.gz.

File metadata

Download URL: midas_zipper-0.2.1.tar.gz
Upload date: Aug 20, 2026
Size: 38.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for midas_zipper-0.2.1.tar.gz
Algorithm	Hash digest
SHA256	`c2ebc7e8fc4650536347cfee7c731d59c7e4170efd115341b5e2e71ef0f0f5b1`
MD5	`be9dd81c3df447ffdf6aee75ea5bb7c5`
BLAKE2b-256	`86ef3ae077022a77fe01ac795181aed88607a8c8b1c5cd2bacbe71b9104e1b7e`

See more details on using hashes here.

Provenance

The following attestation bundles were made for midas_zipper-0.2.1.tar.gz:

Publisher: python-packages.yml on marinerhemant/MIDAS

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: midas_zipper-0.2.1.tar.gz
- Subject digest: c2ebc7e8fc4650536347cfee7c731d59c7e4170efd115341b5e2e71ef0f0f5b1
- Sigstore transparency entry: 2536791459
- Sigstore integration time: Aug 20, 2026
Source repository:
- Permalink: marinerhemant/MIDAS@5adc86cfe63e59fb7fc24a4e59b4516ad728f1f3
- Branch / Tag: refs/tags/midas-zipper-v0.2.1
- Owner: https://github.com/marinerhemant
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-packages.yml@5adc86cfe63e59fb7fc24a4e59b4516ad728f1f3
- Trigger Event: release