convert_hdf5_to_current

soda_analyzer.convert_hdf5_to_current(input_path, output_path, store_summary_displacement=False)

Convert a supported older HDF5 database to the current SODA schema.

Parameters:

• input_path (str or pathlib.Path) – Source file to read.

• output_path (str or pathlib.Path) – Required destination for the converted database. Must differ from the input path and must not already exist.

• store_summary_displacement (bool, optional) – Retain saved initial displacement, default False. Initial summary mode is always removed. Missing displacement in nonempty tables cannot be restored.

Returns:

pathlib.Path – New database path. Input and output must differ; existing destinations are never overwritten.

Raises:

• ValueError – Input and output refer to the same file, or the input schema is unsupported.

• FileExistsError – The destination or temporary destination already exists.

Notes

Accepts 0.0.1, 0.0.3, 0.0.4, 0.0.5 and 0.0.6; 0.0.2 remains unsupported. Writes 0.0.6 directly in the selected summary layout, in bounded row chunks. The original file and final process modes are preserved.