https://github.com/hdfgroup/hdf5
Official HDF5® Library Repository
https://github.com/hdfgroup/hdf5
c cpp database fortran hdf hdf5 java library nosql
Last synced: 28 days ago
JSON representation
Official HDF5® Library Repository
- Host: GitHub
- URL: https://github.com/hdfgroup/hdf5
- Owner: HDFGroup
- License: other
- Created: 2020-04-24T18:25:20.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-09T15:34:12.000Z (12 months ago)
- Last Synced: 2025-04-09T16:39:15.855Z (12 months ago)
- Topics: c, cpp, database, fortran, hdf, hdf5, java, library, nosql
- Language: C
- Homepage: https://www.hdfgroup.org/
- Size: 597 MB
- Stars: 696
- Watchers: 27
- Forks: 285
- Open Issues: 270
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
![HDF5 Logo][u3]
[](https://github.com/HDFGroup/hdf5/blob/develop/LICENSE)
[](https://doi.org/10.5281/zenodo.17808614)
[](https://github.com/HDFGroup/hdf5/actions/workflows/call-workflows.yml?query=branch%3Adevelop)
---
## What is HDF5?
This repository contains a high-performance library's source code and a file format
specification that implements 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](https://www.hdfgroup.org/).
## Quick Start
- **New to HDF5?** Start with the [INSTALL](release_docs/INSTALL) guide for compilation and installation instructions.
- **Ready to build?** See [INSTALL_CMake.txt](release_docs/INSTALL_CMake.txt) for CMake-based builds.
- **Running on HPC?** Check out [README_HPC.md](release_docs/README_HPC.md) for parallel HDF5 configuration.
## Table of Contents
- [What is HDF5?](#what-is-hdf5)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [Help and Support](#help-and-support)
- [Forum and News](#forum-and-news)
- [Release Schedule](#release-schedule)
- [Downloads and Source Code](#downloads-and-source-code)
- [Java Maven Artifacts](#java-maven-artifacts)
- [Contributing](#contributing)
- [How to Cite HDF5](#how-to-cite-hdf5)
- [Build Status](#build-status)
## Documentation
Documentation for all HDF software is available at:
- **All HDF Documentation**: https://support.hdfgroup.org/documentation/index.html
- **Latest HDF5 Library**: https://support.hdfgroup.org/documentation/hdf5/latest
See the [CHANGELOG.md][u1] file in the [release_docs/][u4] directory for information specific
to the features and updates included in this release of the library.
### Platform-Specific Guides
Several files in the [release_docs/][u4] directory provide platform-specific details:
| File | Description |
|------|-------------|
| [INSTALL](release_docs/INSTALL) | General compilation and installation instructions (start here) |
| [INSTALL_CMake.txt](release_docs/INSTALL_CMake.txt) | Building with CMake |
| [README_HPC.md](release_docs/README_HPC.md) | Building and configuring Parallel HDF5 on HPC systems |
| [INSTALL_Windows.txt](release_docs/INSTALL_Windows.txt) | Windows installation |
| [INSTALL_Cygwin.txt](release_docs/INSTALL_Cygwin.txt) | Cygwin installation |
| [USING_HDF5_CMake.txt](release_docs/USING_HDF5_CMake.txt) | Building HDF5 applications with CMake |
| [USING_CMake_Examples.txt](release_docs/USING_CMake_Examples.txt) | Building and testing HDF5 examples with CMake |
## Help and Support
The HDF Group staffs a free Help Desk accessible at https://help.hdfgroup.org and also monitors the [Forum](https://forum.hdfgroup.org). Our free support service is community-based and handled as time allows. We'll do our best to respond to your question as soon as possible, but please note that response times may vary depending on the complexity of the issue and staff availability.
If you're interested in guaranteed response and resolution times, a dedicated technical account manager, and more benefits (all while supporting the open-source work of The HDF Group), please check out [Priority Support](https://www.hdfgroup.org/solutions/priority-support/).
## Forum and News
The [HDF Forum](https://forum.hdfgroup.org) is provided for public announcements, technical questions, and discussions
of interest to the general HDF5 Community.
- [News and Announcements](https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group)
- [HDF5 Topics](https://forum.hdfgroup.org/c/hdf5)
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 [quickstart guide](https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum) for more information on how to get started.
## Release Schedule
![HDF5 release schedule][u2]
HDF5 does not follow a regular release schedule. Instead, updates are based on the
introduction of new features and the resolution of bugs. However, we aim to have at
least one annual release for each maintenance branch.
### Release Progress
[](https://github.com/orgs/HDFGroup/projects/39/views/24)
[](https://github.com/orgs/HDFGroup/projects/39/views/24)
[](https://github.com/orgs/HDFGroup/projects/39/views/24)
The badges above show the current progress of **release-blocking**, **must-do**, and **nice-to-have** issues with colors that reflect completion status:
- 🟢 **Green (90%+)**: Readying for Deployment - most issues completed
- 🟡 **Yellow (60-89%)**: Nearing Completion - on track for release
- 🟠 **Orange (40-59%)**: In Development - attention needed
- 🔴 **Red (<40%)**: Initial Phase - significant issues remain
Click the badges to view the detailed project board with current release items.
## Downloads and Source Code
### Snapshots and Releases
- **Development Snapshots**: https://github.com/HDFGroup/hdf5/releases/tag/snapshot
- **Latest Release**: https://github.com/HDFGroup/hdf5/releases
- **Previous Releases**: https://support.hdfgroup.org/archive/support/ftp/HDF5/releases/index.html
- **Development Code**: https://github.com/HDFGroup/hdf5.git
### HPC Testing Results
[View HPC configure/build/test results on CDash](https://my.cdash.org/index.php?project=HDF5)
## Java Maven Artifacts
HDF5 Java bindings and examples are available as Maven artifacts. For detailed usage instructions including dependency configuration, repository setup, and platform-specific builds, see [HDF5Examples/JAVA/README-MAVEN.md](HDF5Examples/JAVA/README-MAVEN.md).
## Contributing
We welcome contributions to HDF5! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.
### How to Contribute
1. **Report Issues**: Use our [GitHub Issues](https://github.com/HDFGroup/hdf5/issues) to report bugs or request features
2. **Submit Pull Requests**: Fork the repository, make your changes, and submit a PR
3. **Join Discussions**: Participate in the [HDF Forum](https://forum.hdfgroup.org)
For detailed contribution guidelines, please contact us through the [Help Desk](https://help.hdfgroup.org).
## How to Cite HDF5
If you use HDF5 in your research, please cite it. This repository includes a [`CITATION.cff`](CITATION.cff) file containing standard citation metadata.
**Quick DOI:** [10.5281/zenodo.17808614](https://doi.org/10.5281/zenodo.17808614)
## Build Status
Click to expand detailed build status
### Continuous Integration
[](https://github.com/HDFGroup/hdf5/actions/workflows/daily-schedule.yml?query=branch%3Adevelop)
[](https://github.com/HDFGroup/hdf5/actions/workflows/cve.yml?query=branch%3Adevelop)
[](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#hdf5)
[](https://github.com/HDFGroup/hdf5/actions/workflows/linkchecker.yml)
### Integration Testing
[](https://github.com/HDFGroup/hdf5/actions/workflows/hdfeos5.yml?query=branch%3Adevelop)
[](https://github.com/HDFGroup/hdf5/actions/workflows/netcdf.yml?query=branch%3Adevelop)
[](https://github.com/HDFGroup/hdf5/actions/workflows/h5py.yml?query=branch%3Adevelop)
### VOL and VFD Testing
[](https://github.com/HDFGroup/hdf5/actions/workflows/vol.yml?query=branch%3Adevelop)
[](https://github.com/HDFGroup/hdf5/actions/workflows/vfd.yml?query=branch%3Adevelop)
---
[u1]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md
[u2]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/img/release-schedule.png
[u3]: https://github.com/HDFGroup/hdf5/blob/develop/doxygen/img/HDF5.png
[u4]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs