mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-12-27 08:01:04 +08:00
Code Issues Packages Projects Releases Wiki Activity
e7c3c99325
hdf5/README.md

116 lines
6.1 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)
Fix README badges (#4313)
2024-04-03 17:28:53 +08:00
[![develop cmake build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/cmake.yml?branch=develop&label=HDF5%20develop%20CMake%20CI)](https://github.com/HDFGroup/hdf5/actions/workflows/cmake.yml?query=branch%3Adevelop)
[![develop autotools build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/autotools.yml?branch=develop&label=HDF5%20develop%20Autotools%20CI)](https://github.com/HDFGroup/hdf5/actions/workflows/autotools.yml?query=branch%3Adevelop)
Update Actions badges to link to relevant workflow (#3850)
2023-11-15 00:26:36 +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/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)
[![CVE regression](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/cve.yml?branch=develop&label=CVE)](https://github.com/HDFGroup/hdf5/actions/workflows/cve.yml?query=branch%3Adevelop)
Add GitHub actions for testing VOL connectors (#3849) * Fix issue with HDF5_VOL_ALLOW_EXTERNAL CMake variable * Add initial API test workflow * Initialize parallel testing with MPI_THREAD_MULTIPLE when testing API * Add CMake variable to allow specifying a VOL connector's package name * Remove call to MPI_Init in serial API tests While previously necessary, it now interferes with VOL connectors that may need to be initialized with MPI_THREAD_MULTIPLE
2023-11-15 22:20:50 +08:00
[![HDF5 VOL connectors build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/vol.yml?branch=develop&label=HDF5-VOL)](https://github.com/HDFGroup/hdf5/actions/workflows/vol.yml?query=branch%3Adevelop)
Add daily VFD CI workflow (#4176) Adds testing of Subfiling VFD
2024-03-20 04:14:36 +08:00
[![HDF5 VFD build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/vfd.yml?branch=develop&label=HDF5-VFD)](https://github.com/HDFGroup/hdf5/actions/workflows/vfd.yml?query=branch%3Adevelop)
Fix README badges (#4313)
2024-04-03 17:28:53 +08:00
[![1.14 cmake build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/cmake.yml?branch=hdf5_1_14&label=HDF5%201.14%20CMake%20CI)](https://github.com/HDFGroup/hdf5/actions/workflows/cmake.yml?query=branch%3Ahdf5_1_14)
[![1.14 autotools build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/autotools.yml?branch=hdf5_1_14&label=HDF5%201.14%20Autotools%20CI)](https://github.com/HDFGroup/hdf5/actions/workflows/autotools.yml?query=branch%3Ahdf5_1_14)
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)
Add HPC CDash to README.md (#3623)
2023-10-04 01:00:05 +08:00
[HPC configure/build/test results](https://my.cdash.org/index.php?project=HDF5)
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
Added new H5E with tests. (#4049) Added Fortran H5E APIs: h5eregister_class_f, h5eunregister_class_f, h5ecreate_msg_f, h5eclose_msg_f h5eget_msg_f, h5epush_f, h5eget_num_f, h5ewalk_f, h5eget_class_name_f, h5eappend_stack_f, h5eget_current_stack_f, h5eset_current_stack_f, h5ecreate_stack_f, h5eclose_stack_f, h5epop_f, h5eprint_f (C h5eprint v2 signature) Addresses Issue #3987
2024-03-07 19:34:55 +08:00
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
Fix4 readme (#1986) * Update README.md * Update README.md
2022-08-11 02:17:56 +08:00
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,
Added new HDF5 logo and minor text and link changes to README.md (#3085)
2023-06-09 03:57:18 +08:00
tools, and services at [The HDF Group's website](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.
Add gh-pages doxygen link (#3175)
2023-06-23 08:01:22 +08:00
Some changes to portal links when they could be found on docs.hdfgroup.org, and changed the helpdesk link to help.hdfgroup.org (#3893) * Updated some portal links to go directly to docs.hdfgroup. * Fixed some portal and help desk links
2023-12-13 12:21:15 +08:00
https://docs.hdfgroup.org/hdf5/develop/_l_b_a_p_i.html
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
Some changes to portal links when they could be found on docs.hdfgroup.org, and changed the helpdesk link to help.hdfgroup.org (#3893) * Updated some portal links to go directly to docs.hdfgroup. * Fixed some portal and help desk links
2023-12-13 12:21:15 +08:00
https://docs.hdfgroup.org/hdf5/develop/index.html
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
Add gh-pages doxygen link (#3175)
2023-06-23 08:01:22 +08:00
The latest doxygen documentation generated on changes to develop is available at:
https://hdfgroup.github.io/hdf5/
Remove leading / from relative path. (#4101)
2024-03-10 01:08:26 +08:00
See the [RELEASE.txt](release_docs/RELEASE.txt) file in the [release_docs/](release_docs/) directory for information specific
Trim trailing whitespace
2020-04-21 07:12:00 +08:00
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
Remove leading / from relative path. (#4101)
2024-03-10 01:08:26 +08:00
Several more files are located within the [release_docs/](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
Some changes to portal links when they could be found on docs.hdfgroup.org, and changed the helpdesk link to help.hdfgroup.org (#3893) * Updated some portal links to go directly to docs.hdfgroup. * Fixed some portal and help desk links
2023-12-13 12:21:15 +08:00
https://help.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
[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
--------------
Added new HDF5 logo and minor text and link changes to README.md (#3085)
2023-06-09 03:57:18 +08:00
The [HDF Forum](https://forum.hdfgroup.org) is 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
Added new HDF5 logo and minor text and link changes to README.md (#3085)
2023-06-09 03:57:18 +08:00
- News and Announcements
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://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
Added new HDF5 logo and minor text and link changes to README.md (#3085)
2023-06-09 03:57:18 +08:00
- HDF5 Topics
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://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
Added new HDF5 logo and minor text and link changes to README.md (#3085)
2023-06-09 03:57:18 +08:00
conversation. Please read the [instructions](https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum
) pertaining to the Forum's use and configuration.
[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.
Adds release timeline to README.md (#1584)
2022-04-06 06:26:00 +08:00
| Release | New Features |
| ------- | ------------ |
Update README with new release info (#3993)
2024-02-07 04:26:23 +08:00
| 1.14.4 | native float16 support, cloud-optimized HDF5 improvements |
Update README.md for coming Complex number support (#4183)
2024-03-20 13:04:07 +08:00
| 1.14.5 | Complex number support |
Add 1.14.4 to the release schedule (#3434)
2023-08-26 08:23:25 +08:00
| TBD | VFD SWMR |
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
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-30 04:40:27 +08:00
https://github.com/HDFGroup/hdf5/releases/tag/snapshot
[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
Some changes to portal links when they could be found on docs.hdfgroup.org, and changed the helpdesk link to help.hdfgroup.org (#3893) * Updated some portal links to go directly to docs.hdfgroup. * Fixed some portal and help desk links
2023-12-13 12:21:15 +08:00
https://portal.hdfgroup.org/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