model.ClusterModel.from_h5_file#

classmethod ClusterModel.from_h5_file(filename, r_min=None, r_max=None)[source]#

Initialize a model.ClusterModel instance from HDF5 file.

Parameters:

  • filename (str) – The name of the file to read the model from.

  • r_min (float, optional) – The minimum radius

  • r_max (float, optional) – The maximal radius

Notes

Attention

The model.ClusterModel.from_h5_file() method will seek both filename and filename.properties. If the later cannot be found, the model.ClusterModel will lose its attributes and issue a warning.

Examples

>>> from cluster_generator import ClusterModel
>>> hse_model = ClusterModel.from_h5_file("hse_model.h5")