diff options
Diffstat (limited to 'release_docs')
| -rw-r--r-- | release_docs/INSTALL | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/release_docs/INSTALL b/release_docs/INSTALL index 96f4f6e..2dcb9be 100644 --- a/release_docs/INSTALL +++ b/release_docs/INSTALL @@ -132,27 +132,31 @@ CONTENTS filter will succeed but the data will not be compressed. 3.2. Szip (optional) - The HDF5 Library includes a predefined compression filter that - uses the extended-Rice lossless compression algorithm for chunked - datasets. For more information about Szip compression and license + The HDF5 Library includes a predefined compression filter that + uses the extended-Rice lossless compression algorithm for chunked + datasets. For more information about Szip compression and license terms, see http://hdfgroup.org/doc_resource/SZIP/. - Precompiled Szip binaries for each supported platform and a source - tar file can be found at ftp://ftp.hdfgroup.org/lib-external/szip/. - - To configure the HDF5 Library with the Szip compression filter, use - the '--with-szlib=/PATH_TO_SZIP' flag. For more information, see + The Szip source code can be obtained from the HDF5 Download page + http://www.hdfgroup.org/HDF5/release/obtain5.html#extlibs. Building + instructions are available with the Szip source code. + + The HDF Group does not distribute separate Szip precompiled libraries, + but the HDF5 binaries available from + http://www.hdfgroup.org/HDF5/release/obtain5.html include + the Szip encoder enabled binary for the corresponding platform. + + To configure the HDF5 Library with the Szip compression filter, use + the '--with-szlib=/PATH_TO_SZIP' flag. For more information, see section 4.3.7, "Specifying other libraries and headers." - Starting with release 1.6.3, Szip library binaries are distributed - with the encoder enabled (a license may be required to use this binary) - and with the encoder disabled (freely usable without a license). - If the encoder enabled binary is used, Szip compression encoding is - available for an HDF5 application; if the encoder disabled binary is - used, Szip compression is not available. Szip decoding is always - available for applications (i.e., an HDF5 application can always read - Szip-compressed data) if the Szip filter is present, regardless of the - binary used. + Please notice that if HDF5 configure cannot find a valid Szip library, + configure will not fail; in this case, the compression filter will + not be available to the applications. + + To check if Szip compression was successfully configured in, + check the "I/O filters (external):" line in the configure output, + summary section, printed to the standard output. 3.3. MPI and MPI-IO The parallel version of the library is built upon the foundation |