COMPS.Data.Experiment module¶
-
class
COMPS.Data.Experiment.Experiment(name, suite_id=None, description=None, configuration=None)¶ Bases:
COMPS.Data.TaggableEntity.TaggableEntity,COMPS.Data.CommissionableEntity.CommissionableEntity,COMPS.Data.RelatableEntity.RelatableEntity,COMPS.Data.SerializableEntity.SerializableEntityRepresents a grouping of Simulations.
Contains various basic properties accessible by getters (and, in some cases, +setters):
id
+suite_id
+name
+description
owner
date_created
last_modified
Also contains “child objects” (which must be specifically requested for retrieval using the QueryCriteria.select_children() method of QueryCriteria):
tags
configuration
-
property
id¶
-
property
suite_id¶
-
property
name¶
-
property
description¶
-
property
owner¶
-
property
date_created¶
-
property
last_modified¶
-
property
configuration¶
-
classmethod
get(id=None, query_criteria=None)¶ Retrieve one or more Experiments.
- Parameters
id – The id (str or UUID) of the Experiment to retrieve
query_criteria – A QueryCriteria object specifying basic property filters and tag-filters to apply to the set of Experiments returned, as well as which properties and child-objects to fill for the returned Experiments
- Returns
An Experiment or list of Experiments (depending on whether ‘id’ was specified) with basic properties and child-objects assigned as specified by ‘query_criteria’
-
refresh(query_criteria=None)¶ Update properties of an existing Experiment from the server.
- Parameters
query_criteria – A QueryCriteria object specifying which properties and child-objects to refresh on the Experiment
-
get_simulations(query_criteria=None)¶ Retrieve Simulations contained in this Experiment.
- Parameters
query_criteria – A QueryCriteria object specifying basic property filters and tag-filters to apply to the set of Simulations returned, as well as which properties and child-objects to fill for the returned Simulations
- Returns
A list of Simulations with basic properties and child-objects assigned as specified by ‘query_criteria’
-
save()¶ Save a single Experiment. If it’s a new Experiment, an id is automatically assigned.