alab_management.experiment_view.completed_experiment_view module

alab_management.experiment_view.completed_experiment_view module#

A wrapper over the experiment class.

class CompletedExperimentView[source]#

Bases: object

Experiment view manages the experiment status, which is a collection of tasks and samples.

exists(experiment_id)[source]#

Check if an experiment exists in the completed experiment database.

Parameters:

experiment_id (ObjectId) – id of the experiment within completed experiment collection

Return type:

bool

Returns:

bool: True if sample exists in the database

get_experiment(experiment_id)[source]#

Get an experiment from the completed experiment collection.

Parameters:

experiment_id (ObjectId) – id of the experiment within completed experiment collection

Return type:

dict[str, Any]

Returns:

Dict[str, Any]: experiment dict

save_all()[source]#

Saves all completed experiments in the working database to the completed database.

save_experiment(experiment_id)[source]#

Transfers an experiment from the working (standard) database to the completed database. This also transfers all samples and tasks associated with the experiment into the completed database.

Parameters:

experiment_id (ObjectId) – id of the experiment to be transferred

Contents