Debian Codegraph @

doc/information.rst

raw
1 =====================
2 Project information
3 =====================
4
5 Releases
6 --------
7
8 Source code and pre-built binaries (aka Python wheels) for Windows, MacOS and
9 ManyLinux are available at the following places:
10
11 - `Wheels and source code on PyPi <https://pypi.org/project/hdf5plugin/>`_
12 - `Packages on conda-forge <https://anaconda.org/conda-forge/hdf5plugin>`_
13
14 For the history of modifications, see the :doc:`changelog`.
15
16 Project resources
17 -----------------
18
19 - `Source repository <https://github.com/silx-kit/hdf5plugin>`_
20 - `Issue tracker <https://github.com/silx-kit/hdf5plugin/issues>`_
21
22 `hdf5plugin` can be cited with its DOI: `10.5281/zenodo.7257761 <https://doi.org/10.5281/zenodo.7257761>`_.
23
24 Presentations
25 -------------
26
27 .. toctree::
28 :hidden:
29
30 hdf5plugin_EuropeanHUG2023/benchmark.ipynb
31 hdf5plugin_EuropeanHUG2023/hdf5_compressed_chunk_direct_read.ipynb
32 hdf5plugin_EuropeanHUG2023/presentation.ipynb
33
34
35 * `Presentation <https://indico.desy.de/event/39343/contributions/151492/>`_ at the `European HDF Users Group (HUG) Meeting 2023 <https://indico.desy.de/event/39343/>`_:
36
37 - :doc:`Presentation material <hdf5plugin_EuropeanHUG2023/presentation>`
38 (:download:`Notebook <hdf5plugin_EuropeanHUG2023/presentation.ipynb>`),
39 `Video EuHUG2023 <https://youtu.be/IyS_NgAwXuU>`_
40 - Benchmark: :download:`script <hdf5plugin_EuropeanHUG2023/benchmark.py>`, :download:`display notebook <hdf5plugin_EuropeanHUG2023/benchmark.ipynb>`
41 - :doc:`HDF5 compressed chunk direct read example <hdf5plugin_EuropeanHUG2023/hdf5_compressed_chunk_direct_read>`
42 (:download:`Notebook <hdf5plugin_EuropeanHUG2023/hdf5_compressed_chunk_direct_read.ipynb>`)
43
44
45 * :doc:`Presentation <hdf5plugin_EuropeanHUG2022>` at the `European HDF Users Group (HUG) Meeting 2022 <https://www.hdfgroup.org/hug/europeanhug22/>`_:
46
47 - :doc:`Presentation material <hdf5plugin_EuropeanHUG2022>`
48 (:download:`Notebook <hdf5plugin_EuropeanHUG2022.ipynb>`),
49 `Video EuHUG2022 <https://youtu.be/Titp1XRBh9k>`_
50
51
52 * :doc:`Presentation <hdf5plugin_EuropeanHUG2021>` at the `European HDF Users Group (HUG) Summer 2021 <https://www.hdfgroup.org/hug/europeanhug21/>`_:
53
54 - :doc:`Presentation material <hdf5plugin_EuropeanHUG2021>`
55 (:download:`Notebook <hdf5plugin_EuropeanHUG2021.ipynb>`),
56 `Video EuHUG2021 <https://youtu.be/DP-r2omEnrg>`_
57
58
59 HDF5 filters and compression libraries
60 --------------------------------------
61
62 HDF5 compression filters and compression libraries sources were obtained from:
63
64 * `LZ4 plugin <https://github.com/nexusformat/HDF5-External-Filter-Plugins>`_
65 (commit `49e3b65 <https://github.com/nexusformat/HDF5-External-Filter-Plugins/tree/49e3b65eca772bca77af13ba047d8b577673afba>`_)
66 using LZ4.
67 * `bitshuffle plugin <https://github.com/kiyo-masui/bitshuffle>`_ (v0.5.2) using LZ4 and ZStd.
68 * bzip2 plugin (from `PyTables <https://github.com/PyTables/PyTables/>`_ v3.10.2)
69 using `BZip2 <https://sourceware.org/git/bzip2.git>`_ (v1.0.8).
70 * `hdf5-blosc plugin <https://github.com/Blosc/hdf5-blosc>`_ (v1.0.1)
71 using `c-blosc <https://github.com/Blosc/c-blosc>`_ (v1.21.6), LZ4, Snappy, ZLib and ZStd.
72 * hdf5-blosc2 plugin (from `PyTables <https://github.com/PyTables/PyTables/>`_ v3.10.2)
73 using `c-blosc2 <https://github.com/Blosc/c-blosc2>`_ (v2.17.1), LZ4, ZLib and ZStd.
74 * `FCIDECOMP plugin <https://gitlab.eumetsat.int/open-source/data-tailor-plugins/fcidecomp>`_
75 (`v2.1.1 <https://gitlab.eumetsat.int/open-source/data-tailor-plugins/fcidecomp/-/tree/2.1.1>`_)
76 using `CharLS <https://github.com/team-charls/charls>`_ (v2.1.0).
77 * `SZ plugin <https://github.com/szcompressor/SZ>`_
78 (commit `f466775 <https://github.com/szcompressor/SZ/tree/f4667759ead6a902110e80ff838ccdfddbc8dcd7>`_)
79 using `SZ <https://github.com/szcompressor/SZ>`_, ZLib and ZStd.
80 * `H5Z-SPERR plugin <https://github.com/NCAR/H5Z-SPERR>`_ (v0.2.3) using `SPERR <https://github.com/NCAR/SPERR>`_ (v0.8.2).
81 * `SZ3 plugin <https://github.com/szcompressor/SZ3>`_
82 (commit `4bbe9df7e4bcb <https://github.com/szcompressor/SZ3/commit/4bbe9df7e4bcb6ae6339fcb3033100da07fe7434>`_)
83 using `SZ3 <https://github.com/szcompressor/SZ3>`_ and ZStd.
84 * `HDF5-ZFP plugin <https://github.com/LLNL/H5Z-ZFP>`_ (v1.1.1)
85 using `zfp <https://github.com/LLNL/zfp>`_ (v1.0.1).
86 * `HDF5Plugin-Zstandard <https://github.com/aparamon/HDF5Plugin-Zstandard>`_
87 (commit `d5afdb5 <https://github.com/aparamon/HDF5Plugin-Zstandard/tree/d5afdb5f04116d5c2d1a869dc9c7c0c72832b143>`_) using ZStd.
88
89 Sources of compression libraries shared accross multiple filters were obtained from:
90
91 * `LZ4 v1.10.0 <https://github.com/Blosc/c-blosc2/tree/v2.17.1/internal-complibs/lz4-1.10.0>`_
92 * `Snappy v1.2.1 <https://github.com/google/snappy>`_
93 * `ZStd v1.5.6 <https://github.com/Blosc/c-blosc2/tree/v2.17.1/internal-complibs/zstd-1.5.7>`_
94 * `ZLib v1.3.1 <https://github.com/Blosc/c-blosc/tree/v1.21.6/internal-complibs/zlib-1.3.1>`_
95
96 When compiled with Intel IPP, the LZ4 compression library is replaced with `LZ4 v1.9.3 <https://github.com/lz4/lz4/releases/tag/v1.9.3>`_ patched with a patch from Intel IPP 2021.7.0.
97
98 License
99 -------
100
101 The source code of *hdf5plugin* itself is licensed under the MIT license.
102 Use it at your own risk.
103 See `LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/LICENSE>`_.
104
105 The source code of the embedded HDF5 filter plugin libraries is licensed under different open-source licenses.
106 Please read the different licenses:
107
108 * bitshuffle: See `src/bitshuffle/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/bitshuffle/LICENSE>`_
109 * blosc: See `src/hdf5-blosc/LICENSES/ <https://github.com/silx-kit/hdf5plugin/blob/main/src/hdf5-blosc/LICENSES/>`_, `src/c-blosc/LICENSES/ <https://github.com/silx-kit/hdf5plugin/blob/main/src/c-blosc/LICENSES/>`_ and `src/snappy/COPYING <https://github.com/silx-kit/hdf5plugin/blob/main/src/snappy/COPYING>`_
110 * blosc2: See `src/PyTables/LICENSE.txt <https://github.com/silx-kit/hdf5plugin/blob/main/src/PyTables/LICENSE.txt>`_ and `src/c-blosc2/LICENSES/ <https://github.com/silx-kit/hdf5plugin/blob/main/src/c-blosc2/LICENSES/>`_
111 * bzip2: See `src/PyTables/LICENSE.txt <https://github.com/silx-kit/hdf5plugin/blob/main/src/PyTables/LICENSE.txt>`_ and `src/bzip2/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/bzip2/LICENSE>`_
112 * lz4: See `src/LZ4/COPYING <https://github.com/silx-kit/hdf5plugin/blob/main/src/LZ4/COPYING>`_, `src/LZ4/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/LZ4/LICENSE>`_ and `src/c-blosc/LICENSES/LZ4.txt <https://github.com/silx-kit/hdf5plugin/blob/main/src/c-blosc/LICENSES/LZ4.txt>`_
113 * FCIDECOMP: See `src/fcidecomp/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/fcidecomp/LICENSE>`_ and `src/charls/LICENSE.md <https://github.com/silx-kit/hdf5plugin/blob/main/src/charls/LICENSE.md>`_
114 * SPERR: See `src/H5Z-SPERR/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/H5Z-SPERR/LICENSE>`_ and `src/SPERR/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/SPERR/LICENSE>`_
115 * SZ: See `src/SZ/copyright-and-BSD-license.txt <https://github.com/silx-kit/hdf5plugin/blob/main/src/SZ/copyright-and-BSD-license.txt>`_
116 * SZ3: See `src/SZ3/copyright-and-BSD-license.txt <https://github.com/silx-kit/hdf5plugin/blob/main/src/SZ3/copyright-and-BSD-license.txt>`_
117 * zfp: See `src/H5Z-ZFP/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/H5Z-ZFP/LICENSE>`_ and `src/zfp/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/zfp/LICENSE>`_
118 * zstd: See `src/HDF5Plugin-Zstandard/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/src/HDF5Plugin-Zstandard/LICENSE>`_
119
120 The HDF5 v1.10.5 headers (and Windows .lib file) used to build the filters are stored for convenience in the repository. The license is available here: `src/hdf5/COPYING <https://github.com/silx-kit/hdf5plugin/blob/main/src/hdf5/COPYING>`_.