dragonfly_idaice.properties.model module¶

Model IDA ICE Properties.

class dragonfly_idaice.properties.model.ModelIdaiceProperties(host)[source]¶

Bases: object

IDA ICE Properties for Dragonfly Model.

Parameters:: host – A dragonfly_core Model object that hosts these properties.

Properties:

apply_properties_from_dict(data)[source]¶

Apply the IDA ICE properties of a dictionary to the host Model of this object.

Parameters:: data – A dictionary representation of an entire dragonfly-core Model. Note that this dictionary must have ModelIdaiceProperties in order for this method to successfully apply the IDA ICE properties.

check_for_extension(raise_exception=True, detailed=False)[source]¶

Check that the Model is valid for IDA ICE simulation.

This process includes all relevant dragonfly-core checks as well as checks that apply only for IDA ICE.

Parameters:

raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found. (Default: True).
detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.