AverageDielectricConstant
- class openff.evaluator.protocols.analysis.AverageDielectricConstant(protocol_id)[source]
Computes the average value of the dielectric constant from a set of dipole moments (M) and volumes (V) sampled over the course of a molecular simulation such that
eps = 1 + (<M^2> - <M>^2) / (3.0 * eps_0 * <V> * kb * T)
[1]_.References
- [1] A. Glattli, X. Daura and W. F. van Gunsteren. Derivation of an improved simple
point charge model for liquid water: SPC/A and SPC/L. J. Chem. Phys. 116(22): 9811-9828, 2002
Methods
__init__
(protocol_id)apply_replicator
(replicator, template_values)Applies a ProtocolReplicator to this protocol.
can_merge
(other[, path_replacements])Determines whether this protocol can be merged with another.
execute
([directory, available_resources])Execute the protocol.
from_json
(file_path)Create this object from a JSON file.
from_schema
(schema)Initializes a protocol from it's schema definition.
get_attributes
([attribute_type])Returns all attributes of a specific attribute_type.
get_class_attribute
(reference_path)Returns one of this protocols, or any of its children's, attributes directly (rather than its value).
get_value
(reference_path)Returns the value of one of this protocols inputs / outputs.
get_value_references
(input_path)Returns a dictionary of references to the protocols which one of this protocols inputs (specified by input_path) takes its value from.
json
([file_path, format])Creates a JSON representation of this class.
merge
(other)Merges another Protocol with this one.
parse_json
(string_contents)Parses a typed json string into the corresponding class structure.
replace_protocol
(old_id, new_id)Finds each input which came from a given protocol
set_uuid
(value)Prepend a unique identifier to this protocols id.
set_value
(reference_path, value)Sets the value of one of this protocols inputs.
validate
([attribute_type])Validate the values of the attributes.
Attributes
Input - Defines whether this protocols is allowed to merge with other protocols.
Input - The number of bootstrap iterations to perform.
Input - The relative sample size to use for bootstrapping.
A list of pointers to the protocols which this protocol takes input from.
Input - The dipole moments of each sampled configuration.
The unique id of this protocol.
A dictionary of the outputs of this property.
Input - The potential energies which were evaluated at the same configurations and using the same force field parameters as the observable to average.
The inputs which must be set on this protocol.
A serializable schema for this object.
Input - The state at which the observables were computed.
Output - Statistics about the observables from which the average was computed.These include the statistical inefficiency and the index after which the observables have become stationary (i.e.
Output - The average value of the observable.
Input - The volume of each sampled configuration.
- dipole_moments
Input - The dipole moments of each sampled configuration. The default value of this attribute is not set and must be set by the user..
- Type
- volumes
Input - The volume of each sampled configuration. The default value of this attribute is not set and must be set by the user..
- Type
- allow_merging
Input - Defines whether this protocols is allowed to merge with other protocols. The default value of this attribute is
True
.- Type
- apply_replicator(replicator, template_values, template_index=- 1, template_value=None, update_input_references=False)
Applies a ProtocolReplicator to this protocol. This method should clone any protocols whose id contains the id of the replicator (in the format $(replicator.id)).
- Parameters
replicator (ProtocolReplicator) – The replicator to apply.
template_values (list of Any) –
A list of the values which will be inserted into the newly replicated protocols.
This parameter is mutually exclusive with template_index and template_value
template_index (int, optional) –
A specific value which should be used for any protocols flagged as to be replicated by the replicator. This option is mainly used when replicating children of an already replicated protocol.
This parameter is mutually exclusive with template_values and must be set along with a template_value.
template_value (Any, optional) –
A specific index which should be used for any protocols flagged as to be replicated by the replicator. This option is mainly used when replicating children of an already replicated protocol.
This parameter is mutually exclusive with template_values and must be set along with a template_index.
update_input_references (bool) –
If true, any protocols which take their input from a protocol which was flagged for replication will be updated to take input from the actually replicated protocol. This should only be set to true if this protocol is not nested within a workflow or a protocol group.
This option cannot be used when a specific template_index or template_value is providied.
- Returns
A dictionary of references to all of the protocols which have been replicated, with keys of original protocol ids. Each value is comprised of a list of the replicated protocol ids, and their index into the template_values array.
- Return type
dict of ProtocolPath and list of tuple of ProtocolPath and int
- bootstrap_iterations
Input - The number of bootstrap iterations to perform. The default value of this attribute is
250
.- Type
- bootstrap_sample_size
Input - The relative sample size to use for bootstrapping. The default value of this attribute is
1.0
.- Type
- can_merge(other, path_replacements=None)
Determines whether this protocol can be merged with another.
- Parameters
other (
Protocol
) – The protocol to compare against.path_replacements (list of tuple of str, optional) – Replacements to make in any value reference protocol paths before comparing for equality.
- Returns
True if the two protocols are safe to merge.
- Return type
- property dependencies
A list of pointers to the protocols which this protocol takes input from.
- Type
list of ProtocolPath
- execute(directory='', available_resources=None)
Execute the protocol.
- Parameters
directory (str) – The directory to store output data in.
available_resources (ComputeResources) – The resources available to execute on. If None, the protocol will be executed on a single CPU.
- 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 from_schema(schema)
Initializes a protocol from it’s schema definition.
- Parameters
schema (ProtocolSchema) – The schema to initialize the protocol using.
- Returns
The initialized protocol.
- 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
- get_class_attribute(reference_path)
Returns one of this protocols, or any of its children’s, attributes directly (rather than its value).
- Parameters
reference_path (ProtocolPath) – The path pointing to the attribute to return.
- Returns
The class attribute.
- Return type
- get_value(reference_path)
Returns the value of one of this protocols inputs / outputs.
- Parameters
reference_path (ProtocolPath) – The path pointing to the value to return.
- Returns
The value of the input / output
- Return type
Any
- get_value_references(input_path)
Returns a dictionary of references to the protocols which one of this protocols inputs (specified by input_path) takes its value from.
Notes
Currently this method only functions correctly for an input value which is either currently a
ProtocolPath
, or a list / dict which contains at least oneProtocolPath
.- Parameters
input_path (ProtocolPath) – The input value to check.
- Returns
A dictionary of the protocol paths that the input targeted by input_path depends upon.
- Return type
dict of ProtocolPath and ProtocolPath
- id
The unique id of this protocol. The default value of this attribute is not set and must be set by the user..
- Type
- classmethod parse_json(string_contents)
Parses a typed json string into the corresponding class structure.
- potential_energies
Input - The potential energies which were evaluated at the same configurations and using the same force field parameters as the observable to average. This is required to compute ensemble averages of the gradients of the observable with respect to force field parameters. The default value of this attribute is not set. This attribute is optional.
- Type
- replace_protocol(old_id, new_id)
- Finds each input which came from a given protocol
and redirects it to instead take input from a new one.
Notes
This method is mainly intended to be used only when merging multiple protocols into one.
- set_uuid(value)
Prepend a unique identifier to this protocols id. If the id already has a prepended uuid, it will be overwritten by this value.
- Parameters
value (str) – The uuid to prepend.
- set_value(reference_path, value)
Sets the value of one of this protocols inputs.
- Parameters
reference_path (ProtocolPath) – The path pointing to the value to return.
value (Any) – The value to set.
- thermodynamic_state
Input - The state at which the observables were computed. This is required to compute ensemble averages of the gradients of the observable with respect to force field parameters. The default value of this attribute is not set. This attribute is optional.
- Type
- time_series_statistics
Output - Statistics about the observables from which the average was computed.These include the statistical inefficiency and the index after which the observables have become stationary (i.e. equilibrated). The default value of this attribute is not set and must be set by the user..
- Type
TimeSeriesStatistics
- 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 –