Skip to content

Commit 3414a04

Browse files
authored
Merge pull request HDFGroup#343 from bmribler/use_support_url
Used support urls
2 parents 22ed1f6 + 24c2900 commit 3414a04

File tree

10 files changed

+58
-58
lines changed

10 files changed

+58
-58
lines changed

documentation/hdf5-docs/advanced_topics_list.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ redirect_from:
99

1010
| Topic | Description |
1111
| ----------------------------- | ------------------------------------------------------------ |
12-
| [Chunking in HDF5](advanced_topics/chunking_in_hdf5.html) | Provides detailed information regarding chunking in HDF5 |
13-
| [HDF5 File Image Operations (PDF)](https://docs.hdfgroup.org/hdf5/rfc/HDF5FileImageOperations.pdf) | Describes how to work with HDF5 files in memory. Disk I/O is not required when file images are opened, created, read from, or written to |
14-
| [Copying Committed Datatypes with H5Ocopy (PDF)](advanced_topics/CopyingCommittedDatatypesWithH5Ocopy.pdf) | Describes how to copy to another file a dataset that uses a committed datatype or an object with an attribute that uses a committed datatype so that the committed datatype in the destination file can be used by multiple objects|
15-
| [Collective Metadata I/O](advanced_topics/CollectiveMetadataIO.html) | Describes optimizing HDF5 by collecting metadata I/O |
16-
| [Enabling a Strict Consistency Semantics Model in Parallel HDF5 (PDF)](https://docs.hdfgroup.org/hdf5/rfc/RFC%20PHDF5%20Consistency%20Semantics%20MC%20120328.docx.pdf) | Describes how to improve file access consistency semantics with the Parallel HDF5 library |
17-
| [File Space Management](advanced_topics/FileSpaceManagement.html) | Describes mechanisms to manage space in an HDF5 file |
18-
| [Fine-tuning the Metadata Cache](advanced_topics/FineTuningMetadataCache.html) | Describes how to provide better control of the metadata cache |
19-
| [Freeing Memory Allocated by the HDF5 Library (PDF)](https://docs.hdfgroup.org/hdf5/rfc/RFC%20H5free_memory%20v2.pdf) | Describes how inconsistent memory management can cause heap corruption or resource leaks and possible solutions |
20-
| [HDF5 Data Flow Pipeline for H5Dread](advanced_topics/data_flow_pline_H5Dread.html) | Describes data flow when reading raw data from an HDF5 dataset |
21-
| [HDF5 Metadata](advanced_topics/) | Provides a comprehensive overview of the types of metadata used in HDF5 |
22-
| [Introduction to Single-Writer_Multiple-Reader (SWMR)](advanced_topics/intro_SWMR.html) | Enables writing to a file while multiple readers are accessing it |
23-
| [Introduction to the Virtual Dataset - VDS](advanced_topics/intro_VDS.html) | Describes how to present data stored in several HDF5 datasets and files as a single dataset and access the data using HDF5 APIs |
24-
| [Modified Region Writes (PDF)](advanced_topics/ModifiedRegionWrites.pdf) | Describes how to set write operations for in-memory files so that only modified regions are written to storage. Available when the Core (Memory) VFD is used |
25-
| [Page Buffering (PDF)](https://docs.hdfgroup.org/hdf5/rfc/RFC-Page_Buffering.pdf) | Describes how to reduce the number of small accesses in HDF5 by buffering metadata and raw data accesses |
12+
| [Chunking in HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/chunking_in_hdf5.html) | Provides detailed information regarding chunking in HDF5 |
13+
| [HDF5 File Image Operations (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/rfc/HDF5FileImageOperations.pdf) | Describes how to work with HDF5 files in memory. Disk I/O is not required when file images are opened, created, read from, or written to |
14+
| [Copying Committed Datatypes with H5Ocopy (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/CopyingCommittedDatatypesWithH5Ocopy.pdf) | Describes how to copy to another file a dataset that uses a committed datatype or an object with an attribute that uses a committed datatype so that the committed datatype in the destination file can be used by multiple objects|
15+
| [Collective Metadata I/O](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/CollectiveMetadataIO.html) | Describes optimizing HDF5 by collecting metadata I/O |
16+
| [Enabling a Strict Consistency Semantics Model in Parallel HDF5 (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/rfc/RFC%20PHDF5%20Consistency%20Semantics%20MC%20120328.docx.pdf) | Describes how to improve file access consistency semantics with the Parallel HDF5 library |
17+
| [File Space Management](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/FileSpaceManagement.html) | Describes mechanisms to manage space in an HDF5 file |
18+
| [Fine-tuning the Metadata Cache](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/FineTuningMetadataCache.html) | Describes how to provide better control of the metadata cache |
19+
| [Freeing Memory Allocated by the HDF5 Library (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/rfc/RFC%20H5free_memory%20v2.pdf) | Describes how inconsistent memory management can cause heap corruption or resource leaks and possible solutions |
20+
| [HDF5 Data Flow Pipeline for H5Dread](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/data_flow_pline_H5Dread.html) | Describes data flow when reading raw data from an HDF5 dataset |
21+
| [HDF5 Metadata](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/) | Provides a comprehensive overview of the types of metadata used in HDF5 |
22+
| [Introduction to Single-Writer_Multiple-Reader (SWMR)](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/intro_SWMR.html) | Enables writing to a file while multiple readers are accessing it |
23+
| [Introduction to the Virtual Dataset - VDS](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/intro_VDS.html) | Describes how to present data stored in several HDF5 datasets and files as a single dataset and access the data using HDF5 APIs |
24+
| [Modified Region Writes (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/ModifiedRegionWrites.pdf) | Describes how to set write operations for in-memory files so that only modified regions are written to storage. Available when the Core (Memory) VFD is used |
25+
| [Page Buffering (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/rfc/RFC-Page_Buffering.pdf) | Describes how to reduce the number of small accesses in HDF5 by buffering metadata and raw data accesses |
2626
| [Partial Edge Chunks]() | Describes how to control the filtering of partial edge chunks to improve performance when extending datasets |
2727
| [Thread-safe HDF5]() | Information on thread-safety and concurrent access in HDF5 |
28-
| [Using the Direct Chunk Write Function (PDF)](https://docs.hdfgroup.org/hdf5/rfc/DECTRIS%20Integration%20RFC%202012-11-29.pdf) | Describes another way that chunks can be written to datasets |
29-
| [Virtual Object Layer](https://docs.hdfgroup.org/hdf5/develop/_h5_v_l__u_g.html) | An abstraction layer within the HDF5 library that enables different methods for accessing data and objects that conform to the HDF5 data model |
28+
| [Using the Direct Chunk Write Function (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/rfc/DECTRIS%20Integration%20RFC%202012-11-29.pdf) | Describes another way that chunks can be written to datasets |
29+
| [Virtual Object Layer](https://support.hdfgroup.org/documentation/hdf5/latest/_h5_v_l__u_g.html) | An abstraction layer within the HDF5 library that enables different methods for accessing data and objects that conform to the HDF5 data model |
3030

documentation/hdf5-docs/chunking_in_hdf5.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,11 +216,11 @@ Luckily, because each slot in the hash table only occupies the size of the point
216216

217217
## Additional Resources
218218

219-
The slide set [HDF5 Advanced Topics: Chunking in HDF5 (PDF)](advanced_topics/Chunking_Tutorial_EOS13_2009.pdf), a tutorial from HDF and HDF-EOS Workshop XIII (2009) provides additional HDF5 chunking use cases and examples.
219+
The slide set [HDF5 Advanced Topics: Chunking in HDF5 (PDF)](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/Chunking_Tutorial_EOS13_2009.pdf), a tutorial from HDF and HDF-EOS Workshop XIII (2009) provides additional HDF5 chunking use cases and examples.
220220

221221
The page [HDF5 Examples](https://docs.hdfgroup.org/hdf5/develop/_h_d_f5_examples.html) lists many code examples that are regularly tested with the HDF5 library. Several illustrate the use of chunking in HDF5, particularly “Read/Write Chunked Dataset” and any examples demonstrating filters.
222222

223-
[Dataset Chunking Issues](advanced_topics/DSChunkingIssues.md) provides additional information regarding chunking that has not yet been incorporated into this document.
223+
[Dataset Chunking Issues](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/DSChunkingIssues.md) provides additional information regarding chunking that has not yet been incorporated into this document.
224224

225225
Directions for Future Development
226226
As seen above, the HDF5 chunk cache currently requires careful control of the parameters in order to achieve optimal performance. In the future, we plan to improve the chunk cache to be more foolproof in many ways, and deliver acceptable performance in most cases even when no thought is given to the chunking parameters.

documentation/hdf5-docs/hdf5_topics_list.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ redirect_from:
1010

1111
| Topic | Description |
1212
| ----------------------------- | ------------------------------------------------------------ |
13-
| [Environment Variables Used by HDF5](hdf5_topics/EnvVarsUsedByHDF5.html) | Environment variables that can be used when building or using HDF5 |
14-
| [Using Compression in HDF5](hdf5_topics/UsingCompressionInHDF5.html) | Resources regarding compression |
15-
| [Improving I/O Performance When Working with HDF5 Compressed Datasets](hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf) | A description of the factors that should be considered when storing compressed data in HDF5 files and how to tune those parameters to optimize the I/O performance of an HDF5 application when working with compressed datasets (PDF) |
16-
| [Parallel HDF5](hdf5_topics/ParallelHDF5.html) | Information on Parallel HDF5 |
13+
| [Environment Variables Used by HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/EnvVarsUsedByHDF5.html) | Environment variables that can be used when building or using HDF5 |
14+
| [Using Compression in HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/UsingCompressionInHDF5.html) | Resources regarding compression |
15+
| [Improving I/O Performance When Working with HDF5 Compressed Datasets](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf) | A description of the factors that should be considered when storing compressed data in HDF5 files and how to tune those parameters to optimize the I/O performance of an HDF5 application when working with compressed datasets (PDF) |
16+
| [Parallel HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/ParallelHDF5.html) | Information on Parallel HDF5 |
1717
| [Fill Value and Space Allocation Behavior]() | A table summarizing of the behavioral interactions of HDF5 fill value and storage allocation settings |
1818
| [H5Fill Behavior]() | The library's fill value behavior for property list settings |
19-
| [Using Identifiers](hdf5_topics/UsingIdentifiers.html) | Description of how identifiers work |
20-
| [UTF-8 encoding in HDF5 applications](hdf5_topics/UsingUTF-8EncodinginHDF5Apps.html) | Information on using UTF-8 encoding in HDF5 applications |
21-
| [HDF5 Dimension Scale Specification and Design Notes](hdf5_topics/H5DS_Spec.pdf) | |
19+
| [Using Identifiers](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/UsingIdentifiers.html) | Description of how identifiers work |
20+
| [UTF-8 encoding in HDF5 applications](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/UsingUTF-8EncodinginHDF5Apps.html) | Information on using UTF-8 encoding in HDF5 applications |
21+
| [HDF5 Dimension Scale Specification and Design Notes](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/H5DS_Spec.pdf) | |
2222

2323
<!--- In doxygen/technical notes -->
2424
<!--- | [HDF5 Library Release Versions Numbers]() | A description of HDF5 library release version numbering | -->
2525

26-
For more advanced features, see [Advanced Topics in HDF5](advanced_topics_list.html)
26+
For more advanced features, see [Advanced Topics in HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics_list.html)

documentation/hdf5-docs/release_specific_info.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@ redirect_from:
66

77
# Release Specific Information
88

9-
### [HDF5 1.14](release_specifics/hdf5_1_14.html)
10-
* [New Features](release_specifics/new_features_1_14.html)
11-
* [Software Changes from Release to Release](release_specifics/sw_changes_1.14.html)
12-
* [Migrating to HDF5 1.14 from previous releases](release_specifics/Migrating_from_HDF5_1.12_to_HDF5_1.14.html)
9+
### [HDF5 1.14](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/hdf5_1_14.html)
10+
* [New Features](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/new_features_1_14.html)
11+
* [Software Changes from Release to Release](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/sw_changes_1.14.html)
12+
* [Migrating to HDF5 1.14 from previous releases](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/Migrating_from_HDF5_1.12_to_HDF5_1.14.html)
1313

14-
### [HDF5 1.12](release_specifics/hdf5_1_12.html)
15-
* [New Features](release_specifics/new_features_1_12.html)
16-
* [Software Changes from Release to Release](release_specifics/sw_changes_1.12.html)
17-
* [Migrating from HDF5 1.10 to HDF5 1.12](release_specifics/Migrating_from_HDF5_1.10_to_HDF5_1.12.html)
14+
### [HDF5 1.12](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/hdf5_1_12.html)
15+
* [New Features](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/new_features_1_12.html)
16+
* [Software Changes from Release to Release](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/sw_changes_1.12.html)
17+
* [Migrating from HDF5 1.10 to HDF5 1.12](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/Migrating_from_HDF5_1.10_to_HDF5_1.12.html)
1818

19-
### [HDF5 1.10](release_specifics/hdf5_1_10.html)
20-
* [New Features](release_specifics/new_features_1_10.html)
19+
### [HDF5 1.10](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/hdf5_1_10.html)
20+
* [New Features](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/new_features_1_10.html)
2121
* [Why should I care about the HDF5-1.10.2 release? (blog)]()
22-
* [Software Changes from Release to Release](release_specifics/sw_changes_1.10.html)
23-
* [Migrating from HDF5 1.8 to HDF5 1.10](release_specifics/Migrating_from_HDF5_1.8_to_HDF5_1.10.html)
22+
* [Software Changes from Release to Release](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/sw_changes_1.10.html)
23+
* [Migrating from HDF5 1.8 to HDF5 1.10](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/Migrating_from_HDF5_1.8_to_HDF5_1.10.html)
2424

25-
### [HDF5 1.8](release_specifics/hdf5_1_8.html)
25+
### [HDF5 1.8](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/hdf5_1_8.html)
2626
* New Features
27-
* [Software Changes from Release to Release](release_specifics/sw_changes_1.8.html)
27+
* [Software Changes from Release to Release](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/sw_changes_1.8.html)
2828

29-
### [API Compatibility Macros in HDF5](https://docs.hdfgroup.org/hdf5/develop/api-compat-macros.html)
29+
### [API Compatibility Macros in HDF5](https://support.hdfgroup.org/documentation/hdf5/latest/api-compat-macros.html)

documentation/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ redirect_from:
77
# HDF Software Documentation
88

99
## HDF5 Library, Tools, and Extensions
10-
* [Documentation (latest)](/documentation/hdf5/latest/) - User Guide, Reference Manual, and other documentation
11-
* [Release Specific Information](hdf5-docs/release_specific_info.html) - Information specific to each release series
12-
* [HDF5 Application Topics](hdf5-docs/hdf5_topics_list.html) - General and advanced topics in HDF5 for application developers
10+
* [Documentation (latest)](https://support.hdfgroup.org/releases/hdf5/documentation/latest/) - User Guide, Reference Manual, and other documentation
11+
* [Release Specific Information](https://support.hdfgroup.org/releases/hdf5/documentation/release_specific_info.html) - Information specific to each release series
12+
* [HDF5 Application Topics](https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics_list.html) - General and advanced topics in HDF5 for application developers
1313
* [Registered Filter Plugins](https://github.com/HDFGroup/hdf5_plugins/blob/master/docs/RegisteredFilterPlugins.md) - List of registered filter plugins
14-
* [Registered Virtual File Drivers (VFDs)](/documentation/hdf5-docs/registered_virtual_file_drivers_vfds.html) - List of registered VFDs
15-
* [Registered Virtual Object Layer (VOL) Connectors](/documentation/hdf5-docs/registered_vol_connectors.html) - List of registered VOL connectors
14+
* [Registered Virtual File Drivers (VFDs)](https://support.hdfgroup.org/releases/hdf5/documentation/registered_virtual_file_drivers_vfds.html) - List of registered VFDs
15+
* [Registered Virtual Object Layer (VOL) Connectors](https://support.hdfgroup.org/releases/hdf5/documentation/registered_vol_connectors.html) - List of registered VOL connectors
1616

1717
## HDFView
1818

downloads/hdf5/hdf5_1_10_11.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ title: HDF5 Library and Tools 1.10.11
1313
| Release Date | 9/25/23 |
1414
| Additional Release Information | [Documentation](https://docs.hdfgroup.org/hdf5/v1_10/index.html) |
1515
|| [Release Announcement](https://www.hdfgroup.org/2023/09/release-of-hdf5-1-10-11-library-and-tools-newsletter-198/) |
16-
|| [Software Changes From Release to Release for HDF5-1.10](../../documentation/hdf5-docs/release_specifics/sw_changes_1.10.html) |
16+
|| [Software Changes From Release to Release for HDF5-1.10](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/sw_changes_1.10.html) |
1717
|| [Release Notes](https://raw.githubusercontent.com/HDFGroup/hdf5/hdf5_1_10_11/release_docs/RELEASE.txt) |
1818
|| Tested Platforms and Configuration Features |
1919
|| [Compatibility Report for 1.10.10 vs 1.10.11](https://htmlpreview.github.io/?https://github.com/HDFGroup/hdf5doc/blob/master/html/ADGuide/Compatibility_Report/hdf5-1.10.10-vs-hdf5-1.10.11-interface_compatibility_report.html) |

downloads/hdf5/hdf5_1_12_3.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ title: HDF5 Library and Tools 1.12.3
1313
| Release Date | 11/9/23 |
1414
| Additional Release Information | [Documentation](https://docs.hdfgroup.org/hdf5/v1_12/index.html) |
1515
|| [Release Notes](https://github.com/HDFGroup/hdf5/blob/hdf5_1_12_3/release_docs/RELEASE.txt) |
16-
|| [Software Changes From Release to Release for HDF5-1.12](../../documentation/hdf5-docs/release_specifics/sw_changes_1.12.html) |
17-
|| [New Features in HDF5 Release 1.12](../../documentation/hdf5-docs/release_specifics/new_features_1_12.html) |
16+
|| [Software Changes From Release to Release for HDF5-1.12](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/sw_changes_1.12.html) |
17+
|| [New Features in HDF5 Release 1.12](https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/new_features_1_12.html) |
1818
|| [Newsletter Announcement](https://www.hdfgroup.org/2023/11/release-of-hdf5-1-12-3-library-and-tools-newsletter-200/) |
1919
|| [API Compatibility Report between 1.12.2 and 1.12.3](https://htmlpreview.github.io/?https://github.com/HDFGroup/hdf5doc/blob/master/html/ADGuide/Compatibility_Report/hdf5-1.12.2-vs-hdf5-1.12.3-interface_compatibility_report.html) |
2020
|| [Java Interface Compatibility Report between 1.12.2 and 1.12.3](https://htmlpreview.github.io/?https://github.com/HDFGroup/hdf5doc/blob/master/html/ADGuide/Compatibility_Report/hdf5-1.12.2-vs-hdf5-1.12.3-java-interface_compatibility_report.html) |
21-
| **Critical Information** | **This is the last release for HDF5 1.12. Users should move to HDF5 1.14.** <br>[Migrating from HD5 1.12 to HDF5 1.14](/documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.html)|
21+
| **Critical Information** | **This is the last release for HDF5 1.12. Users should move to HDF5 1.14.** <br>[Migrating from HD5 1.12 to HDF5 1.14](https://support.hdfgroup.org/releases/hdf5/documentation/Migrating+from+HDF5+1.12+to+HDF5+1.14.html)|
2222

2323
## Files
2424

0 commit comments

Comments
 (0)