mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-23 16:20:57 +08:00
Code Issues Packages Projects Releases Wiki Activity
74f1a6e5b4
hdf5/README.md

117 lines
5.0 KiB
Markdown
Raw Normal View History

H5F_LIBVER_LATEST changes for move to 1.15 (#2288) * H5F_LIBVER_LATEST changes for move to 1.15 * Add new default api check * Format fixes * Fix default configure * fix lib version tests * Fix another version variable * Add 1.14 doc link
2022-12-22 02:07:25 +08:00
HDF5 version 1.15.0 currently under development
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
![HDF5 Logo](doxygen/img/HDF5.png)
Updates README.md (#2387) * Updates release schedule for 2023 * Fixes broken build badge * Another build badge tweak * Even more badge tweaking * More branch tweaking * More badge tweaking * More badge tweaks * Even more badge tweaking * Adds badges for other branches
2023-01-05 04:44:51 +08:00
[![develop build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=develop&label=develop)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Adevelop)
Add netCDF and HDF-EOS5 badges to README.md (#3065)
2023-06-07 10:13:37 +08:00
[![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?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?query=branch%3Adevelop)
Updates README.md (#2387) * Updates release schedule for 2023 * Fixes broken build badge * Another build badge tweak * Even more badge tweaking * More branch tweaking * More badge tweaking * More badge tweaks * Even more badge tweaking * Adds badges for other branches
2023-01-05 04:44:51 +08:00
[![1.14 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_14&label=1.14)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_14)
[![1.12 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_12&label=1.12)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_12)
[![1.10 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_10&label=1.10)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_10)
Adds build and license shields to README.md (#1641) * First stab at a Github status bar * Adds a .tokeignore file for counting lines of code accurately * Yanks lines of code calculation since it wildly overcounts
2022-04-15 23:20:59 +08:00
[![BSD](https://img.shields.io/badge/License-BSD-blue.svg)](https://github.com/HDFGroup/hdf5/blob/develop/COPYING)
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
*Please refer to the release_docs/INSTALL file for installation instructions.*
[svn-r17418] Maintenance: At some point the part of the file was lost; restored. I am cheking in the file and then will test different scripts to make sure that they do not destroy the file. (I've already tested bin/h5vers and bin/release in 1.8 ). Similar check-in for 1.8 will follow.
2009-08-26 00:27:44 +08:00
Fix4 readme (#1986) * Update README.md * Update README.md
2022-08-11 02:17:56 +08:00
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.
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://www.hdfgroup.org/
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
DOCUMENTATION
-------------
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
This release is fully functional for the API described in the documentation.
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://portal.hdfgroup.org/display/HDF5/The+HDF5+API
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
Full Documentation and Programming Resources for this release can be found at
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://portal.hdfgroup.org/display/HDF5
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
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.
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
Several more files are located within the release_docs/ directory with specific
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
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)
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
INSTALL_parallel - instructions for building and configuring Parallel HDF5
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
INSTALL_Windows and INSTALL_Cygwin - MS Windows installations.
HELP AND SUPPORT
----------------
Information regarding Help Desk and Support services is available at
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
[svn-r17418] Maintenance: At some point the part of the file was lost; restored. I am cheking in the file and then will test different scripts to make sure that they do not destroy the file. (I've already tested bin/h5vers and bin/release in 1.8 ). Similar check-in for 1.8 will follow.
2009-08-26 00:27:44 +08:00
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
FORUM and NEWS
--------------
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
The following public forums are provided for public announcements and discussions
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
of interest to the general HDF5 Community.
[svn-r17418] Maintenance: At some point the part of the file was lost; restored. I am cheking in the file and then will test different scripts to make sure that they do not destroy the file. (I've already tested bin/h5vers and bin/release in 1.8 ). Similar check-in for 1.8 will follow.
2009-08-26 00:27:44 +08:00
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
- Homepage of the Forum
https://forum.hdfgroup.org
[svn-r17418] Maintenance: At some point the part of the file was lost; restored. I am cheking in the file and then will test different scripts to make sure that they do not destroy the file. (I've already tested bin/h5vers and bin/release in 1.8 ). Similar check-in for 1.8 will follow.
2009-08-26 00:27:44 +08:00
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
- News and Announcement
https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group
[svn-r17418] Maintenance: At some point the part of the file was lost; restored. I am cheking in the file and then will test different scripts to make sure that they do not destroy the file. (I've already tested bin/h5vers and bin/release in 1.8 ). Similar check-in for 1.8 will follow.
2009-08-26 00:27:44 +08:00
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
- HDF5 and HDF4 Topics
https://forum.hdfgroup.org/c/hdf5
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
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 following instructions pertaining to the Forum's
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
use and configuration
https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum
[svn-r17418] Maintenance: At some point the part of the file was lost; restored. I am cheking in the file and then will test different scripts to make sure that they do not destroy the file. (I've already tested bin/h5vers and bin/release in 1.8 ). Similar check-in for 1.8 will follow.
2009-08-26 00:27:44 +08:00
Adds release timeline to README.md (#1584)
2022-04-06 06:26:00 +08:00
RELEASE SCHEDULE
----------------
![HDF5 release schedule](doc/img/release-schedule.png)
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
Updates README.md (#2387) * Updates release schedule for 2023 * Fixes broken build badge * Another build badge tweak * Even more badge tweaking * More branch tweaking * More badge tweaking * More badge tweaks * Even more badge tweaking * Adds badges for other branches
2023-01-05 04:44:51 +08:00
are tentative.
**NOTE**: HDF5 1.12 is being retired early due to its incomplete and incompatible VOL
layer.
Adds release timeline to README.md (#1584)
2022-04-06 06:26:00 +08:00
| Release | New Features |
| ------- | ------------ |
Update README.md (#3069)
2023-06-07 20:56:48 +08:00
| 1.10.11 | CVE fixes, Last HDF5 1.10 release |
Updates README.md (#2387) * Updates release schedule for 2023 * Fixes broken build badge * Another build badge tweak * Even more badge tweaking * More branch tweaking * More badge tweaking * More badge tweaks * Even more badge tweaking * Adds badges for other branches
2023-01-05 04:44:51 +08:00
| 1.12.3 | CVE fixes, performance improvements, H5Dchunk\_iter(), last HDF5 1.12 release |
Update README.md (#3069)
2023-06-07 20:56:48 +08:00
| 1.14.2 | CVE fixes, VFD SWMR (tentative) |
Updates README.md (#2387) * Updates release schedule for 2023 * Fixes broken build badge * Another build badge tweak * Even more badge tweaking * More branch tweaking * More badge tweaking * More badge tweaks * Even more badge tweaking * Adds badges for other branches
2023-01-05 04:44:51 +08:00
| 2.0.0 | TBD |
Adds release timeline to README.md (#1584)
2022-04-06 06:26:00 +08:00
This list of feature release versions is also tentative, and the specific release
in which a feature is introduced may change.
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
SNAPSHOTS, PREVIOUS RELEASES AND SOURCE CODE
--------------------------------------------
Periodically development code snapshots are provided at the following URL:
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://gamma.hdfgroup.org/ftp/pub/outgoing/hdf5/snapshots/
[svn-r1316] The last commit via snapshot script clobbered this file. Restoring its rightful content.
1999-06-09 00:30:57 +08:00
Clear RELEASE.txt after HDF5 1.10.2 release Bring README.txt and INSTALL* updates from hdf5_1_10_2 branch to hdf5_1_10 branch. Bring bin/release changes to hdff5_1_10 branch.
2018-04-04 00:54:18 +08:00
Source packages for current and previous releases are located at:
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://portal.hdfgroup.org/display/support/Downloads
[svn-r13234] Updated mailing list with new list names. Added the statement of snapshot releases locations as v1.6 has it.
2007-02-05 20:56:42 +08:00
HDFFV-10868 - add H5Sselect API java wrappers. Also added javadoc comments to H5E and H5s constants.
2020-10-28 05:48:02 +08:00
Development code is available at our Github location:
Updated README.txt to README.md (#1375) * H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
2022-01-15 07:28:04 +08:00
https://github.com/HDFGroup/hdf5.git
[svn-r1316] The last commit via snapshot script clobbered this file. Restoring its rightful content.
1999-06-09 00:30:57 +08:00
Reference in New Issue Copy Permalink