Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Converts the layout format version and chunked indexing types of datasets created with HDF5-1.10 so that applications built with HDF5-1.8 can access them

HTML Wrap
classhdf-rm-content-block
Hdf rm anchor
AnchorNamesyntax
Syntax:
HTML Wrap
classhdf-rm-section
HTML
<pre><code class="language-bash">h5format_convert [OPTIONS] file_name</code></pre>

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section
Info

Motivation:

When datasets are created in a 1.10.x HDF5 file accessed with the latest format, the library will use the latest layout format version for the datasets. This will allow users to take advantage of new features such as virtual storage and the latest index types for chunked datasets. However, applications built with 1.8.x versions of the library will not be able to access these datasets.


When run, the tool will investigate datasets in the file file_name. It will convert datasets as follows:

  1. A chunked dataset: convert the chunk indexing type to version 1 B-tree if the type is not already a version 1 B-tree
  2. A compact or contiguous dataset: downgrade the layout version to 3 if the layout version is not already version 3
  3. A virtual dataset: no action

If errors are encountered, no further conversion will be performed, and the tool will exit with failure.

Hdf rm anchor
AnchorNameoptparms

Options and Parameters:
HTML Wrap
classhdf-rm-section

Options:

Short and Long FormsComments
-h 
--help
The tool will print a usage message and exit with success.
-V 
--version
The tool will print the version # and exit with success.
-v 
--verbose
This will enable the verbose mode. The tool will print the steps being done while converting a dataset.
-d dataset_name 
--dname=dataset_name 
                         
This is the name including its path of the dataset to be converted (the links from the root group to the dataset). If no conversion is needed, the tool will exit with success. Only one dataset can be specified with this option each time the tool is run. If this option is not used, the tool will attempt to convert every dataset in file_name.
-n 
--noop
Noop is short for no operation. The file will not be modified. The tool will perform all the steps except the actual conversion and exit with success. When errors are encountered along the way, the tool will exit with failure.

Parameter:

file_name 
                         
The name of the file that the tool will operate on.

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.10.0Tool introduced in this release.