hdf5/README.md
Allen Byrne ed9791f1ce
Update actions for release option, fix branch for daily build (#3185)
* Update actions for release option, fix branch for daily build

* Scheduled workflows run on latest commit on the develop

* Add snapshots location
2023-06-29 15:40:27 -05:00

5.1 KiB

HDF5 version 1.15.0 currently under development

HDF5 Logo

develop build status HDF-EOS5 build status netCDF build status 1.14 build status 1.12 build status 1.10 build status BSD

Please refer to the release_docs/INSTALL file for installation instructions.

This repository contains a high-performance library's source code and a file format specification that implement the HDF5® data model. The model has been adopted across many industries and this implementation has become a de facto data management standard in science, engineering, and research communities worldwide.

The HDF Group is the developer, maintainer, and steward of HDF5 software. Find more information about The HDF Group, the HDF5 Community, and other HDF5 software projects, tools, and services at The HDF Group's website.

DOCUMENTATION

This release is fully functional for the API described in the documentation.

https://portal.hdfgroup.org/display/HDF5/The+HDF5+API

Full Documentation and Programming Resources for this release can be found at

https://portal.hdfgroup.org/display/HDF5

The latest doxygen documentation generated on changes to develop is available at:

https://hdfgroup.github.io/hdf5/

See the RELEASE.txt file in the release_docs/ directory for information specific to the features and updates included in this release of the library.

Several more files are located within the release_docs/ directory with specific details for several common platforms and configurations.

INSTALL - Start Here. General instructions for compiling and installing the library
INSTALL_CMAKE  - instructions for building with CMake (Kitware.com)
INSTALL_parallel - instructions for building and configuring Parallel HDF5
INSTALL_Windows and INSTALL_Cygwin - MS Windows installations.

HELP AND SUPPORT

Information regarding Help Desk and Support services is available at

https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk

FORUM and NEWS

The HDF Forum is provided for public announcements and discussions of interest to the general HDF5 Community.

These forums are provided as an open and public service for searching and reading. Posting requires completing a simple registration and allows one to join in the conversation. Please read the instructions pertaining to the Forum's use and configuration.

RELEASE SCHEDULE

HDF5 release schedule

HDF5 does not release on a regular schedule. Instead, releases are driven by new features and bug fixes, though we try to have at least one release of each maintenance branch per year. Future HDF5 releases indicated on this schedule are tentative.

NOTE: HDF5 1.12 is being retired early due to its incomplete and incompatible VOL layer.

Release New Features
1.10.11 CVE fixes, Last HDF5 1.10 release
1.12.3 CVE fixes, performance improvements, H5Dchunk_iter(), last HDF5 1.12 release
1.14.2 CVE fixes, VFD SWMR (tentative)
2.0.0 TBD

This list of feature release versions is also tentative, and the specific release in which a feature is introduced may change.

SNAPSHOTS, PREVIOUS RELEASES AND SOURCE CODE

Periodically development code snapshots are provided at the following URL:

https://github.com/HDFGroup/hdf5/releases/tag/snapshot

Source packages for current and previous releases are located at:

https://portal.hdfgroup.org/display/support/Downloads

Development code is available at our Github location:

https://github.com/HDFGroup/hdf5.git