mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
31d9d3c322a4e7e5149eb1597a3221b4f7de1729
hdf5/README.md
T
Scot Breitenfeld 31d9d3c322 Fix release-progress badges to read native issue-level Priority field (#6668) 
* Fix release-progress badges to read native issue-level Priority field

The Project Priority board field was consolidated into a Priority field
managed at the issue level (GitHub's org-wide custom issue fields), which
the GraphQL API mirrors into projects as ProjectV2ItemIssueFieldValue
instead of ProjectV2ItemFieldSingleSelectValue. The badge script's query
had no fragment for that type, so it silently found zero priority values
and would raise ProjectFieldMissingError on every run.

* Show TBD on the Next Release badge when no milestone due date is set

Previously the badge silently omitted any due-date annotation when the
milestone had none, which read as if the badge just hadn't picked one up.

* Update release-schedule image and plantuml source from add-next-release-badge branch

* Don't flag CODEOWNERS auto-assignment as a manual reviewer add on a PR's first pass

GitHub's own CODEOWNERS engine fires an identical review_requested webhook
(sender type User, not Bot) when it auto-assigns owners at PR-open time. If
one of those survives the cancel-in-progress race as the run that actually
executes, it was mistaken for a human deliberately requesting that reviewer,
permanently flagging them "manually added" and requiring separate approval —
e.g. a catch-all "*" owner also named on a touched area's CODEOWNERS line got
flagged on every PR touching that area, even though no human ever picked them.

Gate the manual-add detection and the sticky per-area assignment on
!isFirstCoordinationPass (no checklist comment posted yet), since that's
exactly the window where GitHub's own auto-assignment is indistinguishable
from a real human pick.
2026-09-15 14:32:55 -05:00

197 lines
11 KiB
Markdown
Raw Blame History

<div align="center">
![HDF5 Logo][u3]
[![BSD](https://img.shields.io/badge/License-BSD-blue.svg)](https://github.com/HDFGroup/hdf5/blob/develop/LICENSE)
[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.17808558-blue)](https://doi.org/10.5281/zenodo.17808558)
[![MIME Type](https://img.shields.io/badge/MIME%20Type-application%2Fvnd.hdfgroup.hdf5-orange)](https://www.iana.org/assignments/media-types/application/vnd.hdfgroup.hdf5)
[![develop cmake build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/call-workflows.yml?branch=develop&label=CMake%20CI)](https://github.com/HDFGroup/hdf5/actions/workflows/call-workflows.yml?query=branch%3Adevelop)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7802/badge)](https://www.bestpractices.dev/projects/7802)
</div>
---
## 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.md](docs/INSTALL.md) guide for compilation and installation instructions.
- **Ready to build?** See [INSTALL_CMake.md](docs/INSTALL_CMake.md) for CMake-based builds.
- **Running on HPC?** Check out [README_HPC.md](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 [docs/][u4] directory provide platform-specific details:
| File | Description |
|------|-------------|
| [INSTALL](docs/INSTALL.md) | General compilation and installation instructions (start here) |
| [INSTALL_CMake.md](docs/INSTALL_CMake.md) | Building with CMake |
| [README_HPC.md](docs/README_HPC.md) | Building and configuring Parallel HDF5 on HPC systems |
| [INSTALL_Windows.md](docs/INSTALL_Windows.md) | Windows installation |
| [INSTALL_Cygwin.md](docs/INSTALL_Cygwin.md) | Cygwin installation |
| [USING_HDF5_CMake.md](docs/USING_HDF5_CMake.md) | Building HDF5 applications with CMake |
| [USING_CMake_Examples.md](docs/USING_CMake_Examples.md) | 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. The chart above shows **past HDF5 releases that
have reached end of life (EOL)**.
### Release Progress
The badges below track the release **currently in development**.
[![Next Release](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HDFGroup-Bot/0ad2eabb63b28eb90d69f5e5b2c1496f/raw/release-version-hdf5.json)](https://github.com/orgs/HDFGroup/projects/39/views/24)
[![Latest Release](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HDFGroup-Bot/0ad2eabb63b28eb90d69f5e5b2c1496f/raw/release-latest-hdf5.json)](https://github.com/HDFGroup/hdf5/releases)
[![Critical Priority](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HDFGroup-Bot/0ad2eabb63b28eb90d69f5e5b2c1496f/raw/release-blocker-hdf5.json)](https://github.com/orgs/HDFGroup/projects/39/views/24)
[![High Priority](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HDFGroup-Bot/0ad2eabb63b28eb90d69f5e5b2c1496f/raw/release-mustdo-hdf5.json)](https://github.com/orgs/HDFGroup/projects/39/views/24)
[![Medium Priority](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HDFGroup-Bot/0ad2eabb63b28eb90d69f5e5b2c1496f/raw/release-medium-hdf5.json)](https://github.com/orgs/HDFGroup/projects/39/views/24)
[![Low Priority](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HDFGroup-Bot/0ad2eabb63b28eb90d69f5e5b2c1496f/raw/release-low-hdf5.json)](https://github.com/orgs/HDFGroup/projects/39/views/24)
The **Next Release** badge shows the in-development version (derived from `H5_VERS_MAJOR`/`H5_VERS_MINOR` in
[src/H5public.h](src/H5public.h)), annotated with the target due date of the matching GitHub milestone, or **TBD**
when no due date is set. The **Latest Release** badge shows the most recently published release in that same major series, with its
release date. The badges below them show the current progress of **critical**, **high**, **medium**, and
**low priority** issues for the in-development release, 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.17808558](https://doi.org/10.5281/zenodo.17808558)
## Build Status
<details>
<summary>Click to expand detailed build status</summary>
### Continuous Integration
[![HDF5 develop daily build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/daily-schedule.yml?branch=develop&label=Daily%20Build)](https://github.com/HDFGroup/hdf5/actions/workflows/daily-schedule.yml?query=branch%3Adevelop)
[![CVE regression](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/cve.yml?branch=develop&label=CVE%20Tests)](https://github.com/HDFGroup/hdf5/actions/workflows/cve.yml?query=branch%3Adevelop)
[![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/hdf5.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#hdf5)
[![Link Checker Status](https://github.com/HDFGroup/hdf5/actions/workflows/linkchecker.yml/badge.svg)](https://github.com/HDFGroup/hdf5/actions/workflows/linkchecker.yml)
### Integration Testing
[![HDF-EOS5 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/hdfeos5.yml?branch=develop&label=HDF-EOS5)](https://github.com/HDFGroup/hdf5/actions/workflows/hdfeos5.yml?query=branch%3Adevelop)
[![netCDF build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/netcdf.yml?branch=develop&label=netCDF)](https://github.com/HDFGroup/hdf5/actions/workflows/netcdf.yml?query=branch%3Adevelop)
[![h5py build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/h5py.yml?branch=develop&label=h5py)](https://github.com/HDFGroup/hdf5/actions/workflows/h5py.yml?query=branch%3Adevelop)
### HDF5 filter plugins testing
[![HDF5 plugins testing](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5_plugins/main.yml?branch=master&label=HDF5%20filter%20plugins)](https://github.com/HDFGroup/hdf5_plugins/actions/workflows/main.yml?query=branch%3Amaster)
### VOL and VFD Testing
[![HDF5 VOL connectors build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/vol.yml?branch=develop&label=VOL%20Connectors)](https://github.com/HDFGroup/hdf5/actions/workflows/vol.yml?query=branch%3Adevelop)
[![HDF5 VFD build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/vfd.yml?branch=develop&label=VFD%20Tests)](https://github.com/HDFGroup/hdf5/actions/workflows/vfd.yml?query=branch%3Adevelop)
</details>
---
[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/docs/doxygen/img/HDF5.png
[u4]: https://github.com/HDFGroup/hdf5/blob/develop/docs
Reference in New Issue View Git Blame Copy Permalink