Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.0.16 instead.
Reason given by maintainers: API will change

bslz4_to_sparse

Decompress Dectris Eiger bitshuffle-LZ4 data directly to sparse index/value arrays.

Documentation, with runnable examples and speed on real data: https://jonwright.github.io/bslz4_to_sparse/

This repository brings together upstream code from bitshuffle [1], the DECTRIS bitshuffle SIMD kernels [2], LZ4 [3] and Zstandard [4] to process detector data as a stream (in cache), rather than writing whole images to RAM and reading them back again. Versions before 0.0.16 were mostly written by @jonwright; later versions include a large amount of LLM-generated code (DeepSeek and Claude).

It is used in ImageD11 [5] to convert images directly to sparse format, and it can also do radial integrations as sparse matrix products (for example with the integration matrices of pyFAI [6]). The C/C++ core is a Python extension through c2py23 [7]. Each decoder object has a pipeline: one value per processing step (decode, mask, untranspose, collect, and for matrix objects route and dot), chosen automatically for the CPU, data and matrix unless given; bslz4_to_sparse.describe() lists the values and which ones this machine can run.

After git clone:

git submodule init
git submodule update
python3 -m pip install .

To run it at the ESRF:

cd test
python3 test_vs_hdf5plugin.py
python3 bench1.py

To test a local build without installing:

python3 setup.py build --build-lib=lib
cd test
BSLZ4_TO_SPARSE_PATH=$(pwd)/../lib python3 -m pytest -v
BSLZ4_TO_SPARSE_PATH=$(pwd)/../lib python3 bench1.py

Every script in test/ prepends BSLZ4_TO_SPARSE_PATH to sys.path, so it wins over any installed bslz4_to_sparse and works where PYTHONPATH is ignored (ESRF jupyter-slurm).

The extension is tagged by platform only (_bslz4_to_sparse.c2py23-linux_ppc64le.so); c2py23 resolves the CPython API at runtime, so one binary serves any Python version. Run the build once per machine: a single lib/ on a shared filesystem holds all of them. C2PY_TRACE=1 reports which file the loader picks.

Threads and free-threaded Python (3.14t, 3.15t): the decode entry points release the GIL, and the extension declares itself free-threading safe, so importing it does not re-enable the GIL. Nothing is locked; the rule is one chunk2sparse / chunk2sparseCSC object per thread. Each object reuses its own workspace and output arrays, so the arrays a call returns are overwritten by that object's next call, and a call's inputs (chunks, mmap base, mask) must not be changed or closed by another thread while it runs. Breaking these rules gives wrong results or a crash, not an error. _testing.counters() (test instrumentation) is only exact while one decode runs at a time.

Collect values the machine cannot run (vsx on x86_64, neon on x86_64/POWER, avx512cs/avx2cs/sse2 on POWER/ARM) are skipped by test_simd_collect_matches_scalar.

The licences of the bundled upstream code are in licenses/.

Acknowledgements

This package is mostly a regrouping of other people's work, put together so that detector frames can be decoded and reduced in one pass. The bitshuffle format and its reference implementation come from K. Masui and co-authors [1]; the fast SIMD bit-transpose kernels from K. Conley at DECTRIS [2]; the LZ4 and Zstandard decompressors from Y. Collet and the Zstandard contributors [3], [4]. The integration matrices are pyFAI's [6], and the sparse output serves ImageD11 [5]. The portable Python wrappers come from c2py23 [7]: they let one compiled module load on every CPython from 2.7 to 3.15, free-threaded builds included, without compiling against any Python headers. Our thanks to all of these projects; please cite them as well as this one.

References

[1] bitshuffle, K. Masui et al., https://github.com/kiyo-masui/bitshuffle; K. Masui et al., "A compression scheme for radio data in high performance computing", Astronomy and Computing 12, 181-190 (2015), https://doi.org/10.1016/j.ascom.2015.07.002

[2] bitshuffle SIMD bit-transpose kernels ("kcb"), K. Conley (DECTRIS), https://github.com/kalcutter/bitshuffle

[3] LZ4, Y. Collet, https://github.com/lz4/lz4

[4] Zstandard, Y. Collet and Meta Platforms, https://github.com/facebook/zstd; Y. Collet and M. Kucherawy (ed.), "Zstandard Compression and the 'application/zstd' Media Type", RFC 8878 (2021), https://doi.org/10.17487/RFC8878

[5] ImageD11, https://github.com/FABLE-3DXRD/ImageD11

[6] pyFAI, https://github.com/silx-kit/pyFAI; G. Ashiotis, A. Deschildre, Z. Nawaz, J. P. Wright, D. Karkoulis, F. E. Picca and J. Kieffer, "The fast azimuthal integration Python library: pyFAI", J. Appl. Cryst. 48, 510-519 (2015), https://doi.org/10.1107/S1600576715004306

[7] c2py23, https://github.com/jonwright/c2py23

Metadata

Release files for bslz4-to-sparse 0.0.21a1

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

Source distribution (sdist)

Source distribution for bslz4-to-sparse 0.0.21a1
File Size Uploaded Provenance Actions
bslz4_to_sparse-0.0.21a1.tar.gz 996.4 kB With provenance Details for bslz4_to_sparse-0.0.21a1.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for bslz4-to-sparse 0.0.21a1
File Actions
bslz4_to_sparse-0.0.21a1-py2.py3-none-win_amd64.whl Python 2, Python 3 none Windows x86-64 Details for bslz4_to_sparse-0.0.21a1-py2.py3-none-win_amd64.whl
bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_x86_64.whl Python 2, Python 3 none Linux glibc 2.17+ x86-64 Details for bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_x86_64.whl
bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_ppc64le.whl Python 3, Python 2 none Linux glibc 2.17+ PowerPC 64-le Details for bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_ppc64le.whl
bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_aarch64.whl Python 3, Python 2 none Linux glibc 2.17+ ARM64 Details for bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_aarch64.whl
bslz4_to_sparse-0.0.21a1-py2.py3-none-macosx_11_0_arm64.whl Python 2, Python 3 none macOS 11.0+ ARM64 Details for bslz4_to_sparse-0.0.21a1-py2.py3-none-macosx_11_0_arm64.whl

Total release size: 2.3 MB

Release files / bslz4_to_sparse-0.0.21a1.tar.gz

Download URL bslz4_to_sparse-0.0.21a1.tar.gz
Size 996.4 kB
Tags Source
SHA-256 checksum
How to use checksums
012b9b5b969866d40da4753077931eed45ce4ee55485b5aebbc0c2a09f8bc28f
BLAKE2b-256 checksum
How to use checksums
264b5c9dde26db2449168571d13f87450e1ad2c2a01ab01c429174c62218289b
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 Oct 10, 2026.

Transparency log

Release files / bslz4_to_sparse-0.0.21a1-py2.py3-none-win_amd64.whl

Download URL bslz4_to_sparse-0.0.21a1-py2.py3-none-win_amd64.whl
Size 400.2 kB
Tags Python 2 Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
983dc473eb5b0d8c8b44d5feb85aaf1f02d52028a861d6b71104a433592dc53f
BLAKE2b-256 checksum
How to use checksums
816658b7950afc2798b7a5787ad9a5f7c356b11d93555e0db4215526343d8c7c
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 Oct 10, 2026.

Transparency log

Release files / bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_x86_64.whl

Download URL bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_x86_64.whl
Size 260.0 kB
Tags Linux glibc 2.17+ x86-64 Python 2 Python 3
SHA-256 checksum
How to use checksums
c1f5452c01d60ae53b8a79b8a96d6bb82484b2dc068d57af63a71b21bfa161b4
BLAKE2b-256 checksum
How to use checksums
82323cda4c16f82e9d09cebd4b1a60bce744c30ce225a5526160360f447cb5f3
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 Oct 10, 2026.

Transparency log

Release files / bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_ppc64le.whl

Download URL bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_ppc64le.whl
Size 269.3 kB
Tags Linux glibc 2.17+ PowerPC 64-le Python 2 Python 3
SHA-256 checksum
How to use checksums
37c788ad742f75defb4839a938339f8f0510d94e3d53e13d9d7efbf42d7ea2d2
BLAKE2b-256 checksum
How to use checksums
0a588ae979c9bfb2582e80e032823e2164e0f6c93993e253cf2f46e19a453246
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 Oct 10, 2026.

Transparency log

Release files / bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_aarch64.whl

Download URL bslz4_to_sparse-0.0.21a1-py2.py3-none-manylinux_2_17_aarch64.whl
Size 206.2 kB
Tags Linux glibc 2.17+ ARM64 Python 2 Python 3
SHA-256 checksum
How to use checksums
ee649e15f2324fe669673a88bb8a09317edee0aa7e95bdbc52e434759943c714
BLAKE2b-256 checksum
How to use checksums
91fbcf9f45d41af25b8ebaf4bd7be465db0d570d6672dcad8990990458fab28f
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 Oct 10, 2026.

Transparency log

Release files / bslz4_to_sparse-0.0.21a1-py2.py3-none-macosx_11_0_arm64.whl

Download URL bslz4_to_sparse-0.0.21a1-py2.py3-none-macosx_11_0_arm64.whl
Size 201.1 kB
Tags Python 2 Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
24ab068c6ca9fa048aea6ee8d79a6fd516a667c7bf8c711fb328d78195276fdf
BLAKE2b-256 checksum
How to use checksums
291ac3a913b17854211d5e3e7d5a3192ebb54c426d6a1ac11a6cf144d2260ac2
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 Oct 10, 2026.

Transparency log

Security for bslz4-to-sparse 0.0.21a1

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

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for bslz4_to_sparse-0.0.21a1.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 Oct 10, 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