Version 5.3.0

[jpivarski]

New features

• feat: use cramjam for lzma, lz4, and zstd, opt-in use of isal for zlib by @lgray in feat: use cramjam for lzma, lz4, and zstd, opt-in use of isal for zlib #1090
• feat: expose decompression_executor and interpretation_executor in uproot dask by @ioanaif in feat: expose decompression_executor and interpretation_executor in uproot dask #1120

Bug-fixes and performance

• fix: missing '_fh' and '_file' attributes after unpickling by @jpivarski in fix: missing '_fh' and '_file' attributes after unpickling #1118
• fix: fix dask_write docs by @zbilodea in fix: fix dask_write docs #1122
• fix: attempt to concatenate numpy and awkward arrays by @ioanaif in fix: attempt to concatenate numpy and awkward arrays #1114
• fix: test suite creates files not in tmp_path by @ioanaif in fix: test suite creates files not in tmp_path #1123
• fix: allow colon in key names by @ioanaif in fix: allow colon in key names #1127
• fix: allow writing generic UHI-compatible histograms by @YSelfTool in fix: allow writing generic UHI-compatible histograms #1128

Other

• docs: add YSelfTool as a contributor for code by @allcontributors in docs: add YSelfTool as a contributor for code #1131
• chore: update pre-commit hooks by @pre-commit-ci in chore: update pre-commit hooks #1110
• chore: update pre-commit hooks by @pre-commit-ci in chore: update pre-commit hooks #1119
• chore: update pre-commit hooks by @pre-commit-ci in chore: update pre-commit hooks #1133

New Contributors

• @YSelfTool made their first contribution in fix: allow writing generic UHI-compatible histograms #1128

Full Changelog: v5.2.2...v5.3.0

---

This discussion was created from the release Version 5.3.0.

[raymondEhlers]

Low priority question, but are there any further docs regarding #1090? From reading through the PR, It sounds like there are performance improvements, but some are opt-in only? Are there tradeoffs in doing so? To opt in, I just need to install the right package? (isal?). Thanks!

[jpivarski]

ISAL is the only performance improvement. The motivation for going to cramjam was portability. (In fact, the ISAL part is unrelated and technically should have been a different PR.)

It's in the documentation, though buried: https://uproot.readthedocs.io/en/latest/uproot.compression.ZLIB.html

If ZLIB.library is "zlib" (default), Uproot uses zlib from the Python standard library.

If ZLIB.library is "isal" (default), Uproot uses isal.isal_zlib.

(I'm fixing the docs failure: d246424.)

For more detail on ISAL:

• Intel technical note
• Python library for ISAL
• StackOverflow issues

[raymondEhlers]

Okay, great - thanks for clarifying and for the links!