Rig

rig

__all__ module-attribute

__all__ = ['Rig', 'Device', 'DatedCalibration']

DatedCalibration pydantic-model

Bases: BaseModel

Base model for dated calibrations.

Fields:

• date (Optional[DefaultAwareDatetime])

date pydantic-field

date = None

Date of the calibration

Device pydantic-model

Bases: BaseModel

A device in the rig configuration. All devices are expected to derive from this base class.

Fields:

• device_type (str)
• calibration (Optional[SerializeAsAny[BaseModel]])

device_type pydantic-field

device_type

Device type

calibration pydantic-field

calibration = None

Calibration for the device.

Rig pydantic-model

Bases: SchemaVersionedModel

Base model for rig configuration. All rig configurations should derive from this base class.

Fields:

• aind_behavior_services_pkg_version (Literal[__semver__])
• version (str)
• computer_name (str)
• rig_name (str)
• data_directory (Path)

aind_behavior_services_pkg_version pydantic-field

aind_behavior_services_pkg_version = __semver__

version pydantic-field

version

schema version

computer_name pydantic-field

computer_name

Computer name

rig_name pydantic-field

rig_name

Rig name

data_directory pydantic-field

data_directory

Directory where data will be saved to

coerce_version classmethod

coerce_version(v, ctx)

Source code in src/aind_behavior_services/base.py

@field_validator("aind_behavior_services_pkg_version", "version", mode="before", check_fields=False)
@classmethod
def coerce_version(cls, v: str, ctx) -> str:
    return coerce_schema_version(cls, v, ctx.field_name)