-
-
Notifications
You must be signed in to change notification settings - Fork 269
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update and Add general INSTALL #4016
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
************************************************************************* | ||
* Installation Instructions for HDF5 * | ||
************************************************************************* | ||
|
||
Instructions for the Installation of HDF5 Software | ||
================================================== | ||
|
||
This file provides instructions for installing the HDF5 software. | ||
|
||
For help with installing, questions can be posted to the HDF Forum or sent to the HDF Helpdesk: | ||
|
||
HDF Forum: https://forum.hdfgroup.org/ | ||
HDF Helpdesk: https://hdfgroup.atlassian.net/servicedesk/customer/portals | ||
|
||
CONTENTS | ||
-------- | ||
1. Obtaining HDF5 | ||
2. Third-party Software Requirements | ||
2.1. Zlib | ||
2.2 Szip (optional) | ||
2.3. MPI and MPI-IO | ||
|
||
|
||
|
||
***************************************************************************** | ||
|
||
1. Obtaining HDF5 | ||
The latest supported public releases of HDF5 are available on | ||
https://github.com/HDFGroup/hdf5. | ||
|
||
2. Third-party Software Requirements | ||
2.1. Zlib | ||
The HDF5 library includes a predefined compression filter that | ||
uses the "deflate" method for chunked datasets. If zlib-1.1.2 or | ||
later is found, HDF5 will use it. Otherwise, HDF5's predefined | ||
compression method will degenerate to a no-op; the compression | ||
filter will succeed but the data will not be compressed. | ||
|
||
2.2. Szip (optional) | ||
The HDF5 library includes a predefined compression filter that | ||
uses the extended-Rice lossless compression algorithm for chunked | ||
datasets. For information on Szip compression, license terms, | ||
and obtaining the Szip source code, see: | ||
|
||
https://portal.hdfgroup.org/display/HDF5/Szip+Compression+in+HDF+Products | ||
|
||
Building instructions are available with the Szip source code. | ||
|
||
The HDF Group does not distribute separate Szip precompiled libraries, | ||
but the HDF5 pre-built binaries provided on The HDF Group download page | ||
include the Szip library with the encoder enabled. These can be found | ||
here: | ||
|
||
https://www.hdfgroup.org/downloads/hdf5/ | ||
|
||
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. | ||
|
||
2.3. MPI and MPI-IO | ||
The parallel version of the library is built upon the foundation | ||
provided by MPI and MPI-IO. If these libraries are not available | ||
when HDF5 is configured, only a serial version of HDF5 can be built. | ||
|
||
3. HDF5 Source Code and Precompiled Binaries | ||
The HDF Group provides source code and pre-compiled binaries from the | ||
HDF5 github releases page: | ||
|
||
https://github.com/HDFGroup/hdf5/releases | ||
|
||
4. Build and Install HDF5 on Unix and Mac OSX Platforms with autotools | ||
see the release_docs/INSTALL_Autotools.txt file. | ||
|
||
5. Build and Install HDF5 Libraries and tools with CMake | ||
see the release_docs/INSTALL_CMake.txt file. | ||
|
||
|
||
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dysfunctional link (Content not found)
Should the link be replaced or accompanied by a link for libaec: https://gitlab.dkrz.de/k202009/libaec or https://gitlab.dkrz.de/k202009/libaec/-/releases?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestions? Maybe that missing file should be in doxygen anyway?