vivyd.data.Experiment#

class Experiment(*, name, info, date)[source]#

Bases: Container

A class representing an experiment within a study. An experiment is a specific run of data acquisition. Simply said, an experiment corresponds to time the experiment hits the “start” button. An experiment can contain one or more bundles collecting data from different sources.

Parameters:

  • name (str) – The name of the experiment.

  • date (datetime) – The date and time when the experiment was conducted.

  • info (dict[str, Any]) – Additional metadata about the experiment, such as experimental conditions, measurement techniques, etc. This is a flexible field that can hold any relevant information that does not fit into the predefined fields.

Attributes#

Experiment.date: datetime#

Methods#

Experiment.add(*bundle)[source]#

Add one or more bundles to the experiment.

Parameters:

*bundle (Bundle) – One or more bundle objects to add to the experiment.

Returns:

The experiment with the added bundles.

Return type:

Experiment