You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ redirect_from:
7
7
# Migrating from HDF5 1.12 to HDF5 1.14
8
8
9
9
## API Changes
10
-
There are new API calls that require API Compatibility Macros in HDF5 1.14.0. There are, however, two API calls which have had their signature change.
10
+
There are new API calls that require [API Compatibility Macros](/documentation/hdf5/latest/api-compat-macros.html) in HDF5 1.14.0. There are, however, two API calls which have had their signature change.
11
11
12
12
### `H5Iregister_type()` / `H5I_free_t`
13
13
The signature of `H5Iregister_type()` did not change, but the `H5I_free_t` callback it accepts did have its signature change to add an asynchronous request parameter. There is no API compatibility macro to paper over this change. The request parameter can be ignored in the callback if you are not concerned with asynchronous operations and future IDs. A description of how the request parameter should be used will be found in the (soon to be released) HDF5 Asynchronous Programming Guide.
|[Chunking in HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/chunking_in_hdf5.html)| Provides detailed information regarding chunking in HDF5 |
12
+
|[Chunking in HDF5](/documentation/advanced_topics/chunking_in_hdf5.html)| Provides detailed information regarding chunking in HDF5 |
13
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|
|[Copying Committed Datatypes with H5Ocopy (PDF)](/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|
|[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 |
17
+
|[File Space Management](/documentation/advanced_topics/FileSpaceManagement.html)| Describes mechanisms to manage space in an HDF5 file |
18
+
|[Fine-tuning the Metadata Cache](/documentation/advanced_topics/FineTuningMetadataCache.html)| Describes how to provide better control of the metadata cache |
19
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 |
20
+
|[HDF5 Data Flow Pipeline for H5Dread](/documentation/advanced_topics/data_flow_pline_H5Dread.html)| Describes data flow when reading raw data from an HDF5 dataset |
21
+
|[HDF5 Metadata](/documentation/advanced_topics/)| Provides a comprehensive overview of the types of metadata used in HDF5 |
22
+
|[Introduction to Single-Writer_Multiple-Reader (SWMR)](/documentation/advanced_topics/intro_SWMR.html)| Enables writing to a file while multiple readers are accessing it |
23
+
|[Introduction to the Virtual Dataset - VDS](/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)](/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
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 |
26
26
|[Partial Edge Chunks]()| Describes how to control the filtering of partial edge chunks to improve performance when extending datasets |
27
27
|[Thread-safe HDF5]()| Information on thread-safety and concurrent access in HDF5 |
Copy file name to clipboardExpand all lines: documentation/hdf5-docs/hdf5_topics/CollectiveCallsInParallel.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -10,22 +10,22 @@ redirect_from:
10
10
This document addresses two topics of concern in a parallel computing environment:
11
11
* HDF5 functions that must be called collectively and when
12
12
* Properties that must be used in a coordinated manner
13
-
The term Macro in the “Additional notes” column indicates that the first item in the “Function” column of the same row is a macro that is selectively mapped to one of the two immediately-following functions. For example, H5Acreate is a macro that can be mapped to either H5Acreate1 or H5Acreate2. This mapping is configurable and is explained in [API Compatibility Macros in HDF5](API compatibility...). The macro structure was introduced at HDF5 Release 1.8.0.
13
+
The term Macro in the “Additional notes” column indicates that the first item in the “Function” column of the same row is a macro that is selectively mapped to one of the two immediately-following functions. For example, H5Acreate is a macro that can be mapped to either H5Acreate1 or H5Acreate2. This mapping is configurable and is explained in [API Compatibility Macros in HDF5](/documentation/hdf5/latest/api-compat-macros.html). The macro structure was introduced at HDF5 Release 1.8.0.
14
14
15
15
## Always collective
16
16
The following functions must always be called collectively.
17
17
18
18
| API | Function | All processes:<br>same datatype<br>& dataspace | All processes:<br>same access<br>properties | All processes:<br>same creation<br>properties | Available<br>in releases since | Additional notes |
| H5A | H5Acreate<br>H5Acreate1<br>H5Acreate2 | ✓ | ✓ | ✓ | 1.8.x |[Macro](API compatibility...)<br>The function H5Acreate was renamed to H5Acreate1 at Release 1.8.0. |
20
+
| H5A | H5Acreate<br>H5Acreate1<br>H5Acreate2 | ✓ | ✓ | ✓ | 1.8.x |[Macro](/documentation/hdf5/latest/api-compat-macros.html)<br>The function H5Acreate was renamed to H5Acreate1 at Release 1.8.0. |
21
21
|| H5Acreate_by_name | ✓ | ✓ | ✓ | 1.8.x ||
22
22
|| H5Adelete ||||||
23
23
|| H5Adelete_by_idx |||| 1.8.x ||
24
24
|| H5Adelete_by_name |||| 1.8.x ||
25
25
|| H5Arename |||| 1.6.x ||
26
26
|| H5Arename_by_name |||| 1.8.x ||
27
27
|| H5Awrite ||||| Because raw data for an attribute is cached locally, all processes must participate in order to guarantee that future H5Aread calls return correct results on all processes. |
28
-
| H5D | H5Dcreate<br>H5Dcreate1<br>H5Dcreate2 | ✓ | ✓ | ✓ | 1.8.x |[Macro](API compatibility...)<br>The function H5Dcreate was renamed to H5Dcreate1 at Release 1.8.0. |
28
+
| H5D | H5Dcreate<br>H5Dcreate1<br>H5Dcreate2 | ✓ | ✓ | ✓ | 1.8.x |[Macro](/documentation/hdf5/latest/api-compat-macros.html)<br>The function H5Dcreate was renamed to H5Dcreate1 at Release 1.8.0. |
29
29
|| H5Dcreate_anon | ✓ | ✓ | ✓ | 1.8.x ||
30
30
|| H5Dextend ||||| All processes must participate only if the number of chunks in the dataset actually changes.<br>All processes must use the same dataspace dimensions. |
31
31
|| H5Dset_extent |||| 1.6.x | All processes must participate only if the number of chunks in the dataset actually changes.<br>All processes must use the same dataspace dimensions. |
@@ -36,7 +36,7 @@ The following functions must always be called collectively.
36
36
|| H5Fopen || ✓ ||||
37
37
|| H5Freopen ||||||
38
38
|| H5Funmount ||||||
39
-
| H5G | H5Gcreate<br>H5Gcreate1<br>H5Gcreate2 || ✓ | ✓ | 1.8.x |[Macro](API compatibility...)<br>The function H5Gcreate was renamed to H5Gcreate1 at Release 1.8.0. |
39
+
| H5G | H5Gcreate<br>H5Gcreate1<br>H5Gcreate2 || ✓ | ✓ | 1.8.x |[Macro](/documentation/hdf5/latest/api-compat-macros.html)<br>The function H5Gcreate was renamed to H5Gcreate1 at Release 1.8.0. |
40
40
|| H5Gcreate_anon || ✓ | ✓ | 1.8.x ||
41
41
|| H5Glink ||||||
42
42
|| H5Glink2 |||| 1.6.x ||
@@ -61,7 +61,7 @@ The following functions must always be called collectively.
61
61
|| H5Oset_comment |||| 1.8.x ||
62
62
|| H5Oset_comment_by_name |||| 1.8.x ||
63
63
| H5R | H5Rcreate ||||||
64
-
| H5T | H5Tcommit<br>H5Tcommit1<br>H5Tcommit2 || ✓ | ✓ | 1.8.x |[Macro](API compatibility...)<br>The function H5Tcommit was renamed to H5Tcommit1 at Release 1.8.0. |
64
+
| H5T | H5Tcommit<br>H5Tcommit1<br>H5Tcommit2 || ✓ | ✓ | 1.8.x |[Macro](/documentation/hdf5/latest/api-compat-macros.html)<br>The function H5Tcommit was renamed to H5Tcommit1 at Release 1.8.0. |
65
65
|| H5Tcommit_anon || ✓ | ✓ | 1.8.x ||
66
66
67
67
## Collective, unless target object will not be modified
@@ -77,9 +77,9 @@ The following functions must normally be called collectively. If, however, the t
77
77
|| H5Aopen_idx || ✓ ||||
78
78
|| H5Aopen_name || ✓ ||||
79
79
| H5D | H5Dclose |||| 1.8.x | All processes must participate only if all file identifiers for a file have been closed and this is the last outstanding object identifier. |
80
-
|| H5Dopen<br>H5Dopen1<br>H5Dopen2 || ✓ || 1.8.x |[Macro](API compatibility...)<br>The function H5Dopen was renamed to H5Dopen1 at Release 1.8.0. |
80
+
|| H5Dopen<br>H5Dopen1<br>H5Dopen2 || ✓ || 1.8.x |[Macro](/documentation/hdf5/latest/api-compat-macros.html)<br>The function H5Dopen was renamed to H5Dopen1 at Release 1.8.0. |
81
81
| H5G | H5Gclose ||||| All processes must participate only if all file identifiers for a file have been closed and this is the last outstanding object identifier. |
82
-
|| H5Gopen<br>H5Gopen1<br>H5Gopen2 || ✓ || 1.8.x |[Macro](API compatibility...)<br>The function H5Gopen was renamed to H5Dopen1 at Release 1.8.0. |
82
+
|| H5Gopen<br>H5Gopen1<br>H5Gopen2 || ✓ || 1.8.x |[Macro](/documentation/hdf5/latest/api-compat-macros.html)<br>The function H5Gopen was renamed to H5Dopen1 at Release 1.8.0. |
83
83
| H5I | H5Iget_file_id |||| 1.8.x ||
84
84
| H5O | H5Oclose |||| 1.8.x | All processes must participate only if all file identifiers for a file have been closed and this is the last outstanding object identifier. |
85
85
|| H5Oopen || ✓ || 1.8.x ||
@@ -89,7 +89,7 @@ The following functions must normally be called collectively. If, however, the t
89
89
| H5T | H5Tclose ||||| All processes must participate only if the datatype is for a committed datatype, all the file identifiers for the file have been closed, and this is the last outstanding object identifier. |
|[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 |
13
+
|[Environment Variables Used by HDF5](/documentation/hdf5_topics/EnvVarsUsedByHDF5.html)| Environment variables that can be used when building or using HDF5 |
14
+
|[Using Compression in HDF5](/documentation/hdf5_topics/UsingCompressionInHDF5.html)| Resources regarding compression |
15
+
|[Improving I/O Performance When Working with HDF5 Compressed Datasets](/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](/documentation/hdf5_topics/ParallelHDF5.html)| Information on Parallel HDF5 |
17
17
|[Fill Value and Space Allocation Behavior]()| A table summarizing of the behavioral interactions of HDF5 fill value and storage allocation settings |
18
18
|[H5Fill Behavior]()| The library's fill value behavior for property list settings |
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)||
19
+
|[Using Identifiers](/documentation/hdf5_topics/UsingIdentifiers.html)| Description of how identifiers work |
20
+
|[UTF-8 encoding in HDF5 applications](/documentation/hdf5_topics/UsingUTF-8EncodinginHDF5Apps.html)| Information on using UTF-8 encoding in HDF5 applications |
21
+
|[HDF5 Dimension Scale Specification and Design Notes](/documentation/hdf5_topics/H5DS_Spec.pdf)||
22
22
23
23
<!--- In doxygen/technical notes -->
24
24
<!--- | [HDF5 Library Release Versions Numbers]() | A description of HDF5 library release version numbering | -->
25
25
26
-
For more advanced features, see [Advanced Topics in HDF5](https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics_list.html)
26
+
For more advanced features, see [Advanced Topics in HDF5](/documentation/hdf5-docs/advanced_topics_list.html)
0 commit comments