BaseSimulationData¶
-
class
openff.evaluator.storage.data.
BaseSimulationData
[source]¶ A base class for classes which will store the outputs of a molecular simulation
-
__init__
()¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
()Initialize self.
from_json
(file_path)Create this object from a JSON file.
get_attributes
([attribute_type])Returns all attributes of a specific attribute_type.
Returns whether this data object requires an accompanying data directory-like structure.
json
([file_path, format])Creates a JSON representation of this class.
most_information
(stored_data_1, stored_data_2)Returns the data object with the highest information content.
parse_json
(string_contents[, encoding])Parses a typed json string into the corresponding class structure.
Returns the storage query which would match this data object.
validate
([attribute_type])Validate the values of the attributes.
Attributes
The id of the force field parameters used to generate the data.
The phase of the system (e.g.
The server id of the calculation which yielded this data.
A description of the composition of the stored system.
The state at which the data was collected.
-
substance
¶ A description of the composition of the stored system. The default value of this attribute is not set and must be set by the user..
- Type
-
thermodynamic_state
¶ The state at which the data was collected. The default value of this attribute is not set and must be set by the user..
- Type
-
property_phase
¶ The phase of the system (e.g. liquid, gas). The default value of this attribute is not set and must be set by the user..
- Type
-
source_calculation_id
¶ The server id of the calculation which yielded this data. The default value of this attribute is not set and must be set by the user..
- Type
-
force_field_id
¶ The id of the force field parameters used to generate the data. The default value of this attribute is not set and must be set by the user..
- Type
-
classmethod
has_ancillary_data
()[source]¶ Returns whether this data object requires an accompanying data directory-like structure.
- Returns
True if this class requires an accompanying data directory-like structure.
- Return type
-
classmethod
from_json
(file_path)¶ Create this object from a JSON file.
- Parameters
file_path (str) – The path to load the JSON from.
- Returns
The parsed class.
- Return type
cls
-
classmethod
get_attributes
(attribute_type=None)¶ Returns all attributes of a specific attribute_type.
- Parameters
attribute_type (type of Attribute, optional) – The type of attribute to search for.
- Returns
The names of the attributes of the specified type.
- Return type
list of str
-
json
(file_path=None, format=False)¶ Creates a JSON representation of this class.
-
abstract classmethod
most_information
(stored_data_1, stored_data_2)¶ Returns the data object with the highest information content.
- Parameters
stored_data_1 (ReplaceableData) – The first piece of data to compare.
stored_data_2 (ReplaceableData) – The second piece of data to compare.
- Returns
The data object with the highest information content, or None if the two pieces of information are incompatible with one another.
- Return type
ReplaceableData, optional
-
classmethod
parse_json
(string_contents, encoding='utf8')¶ Parses a typed json string into the corresponding class structure.
-
to_storage_query
()¶ Returns the storage query which would match this data object.
- Returns
The storage query which would match this data object.
- Return type
-
validate
(attribute_type=None)¶ Validate the values of the attributes. If attribute_type is set, only attributes of that type will be validated.
- Parameters
attribute_type (type of Attribute, optional) – The type of attribute to validate.
- Raises
ValueError or AssertionError –
-