Utilities documentation

Utility functions that are unrelated to peridynamics.

peripy.utilities.read_array(read_path, dataset)

Read a :class numpy.ndarray: from a HDF5 file.

Parameters:

• read_path (path-like or str) – The path to which the HDF5 file is written.
• dataset (str) – The name of the dataset stored in the HDF5 file.

Returns:

An array which was stored on disk.

Return type:

class numpy.ndarray:  

peripy.utilities.write_array(write_path, dataset, array)

Write a :class: numpy.ndarray to a HDF5 file.

Parameters:

• write_path (path-like or str) – The path to which the HDF5 file is written.
• dataset (str) – The name of the dataset stored in the HDF5 file.

Array:

The array to be written to file.

Returns:

None

Return type:

None type