deploy: 60638c2

AllenNeuralDynamics · Nov 20, 2024 · c7cd32d · c7cd32d
commit c7cd32d
Show file tree

Hide file tree

Showing 142 changed files with 27,757 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ffbcb2f1419685c2cae3d11f3e36c580
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.base.doctree b/.doctrees/api.base.doctree
diff --git a/.doctrees/api.base/rig.doctree b/.doctrees/api.base/rig.doctree
diff --git a/.doctrees/api.base/session.doctree b/.doctrees/api.base/session.doctree
diff --git a/.doctrees/api.base/task_logic.doctree b/.doctrees/api.base/task_logic.doctree
diff --git a/.doctrees/api.calibration.doctree b/.doctrees/api.calibration.doctree
diff --git a/.doctrees/api.calibration/aind_manipulator.doctree b/.doctrees/api.calibration/aind_manipulator.doctree
diff --git a/.doctrees/api.calibration/load_cells.doctree b/.doctrees/api.calibration/load_cells.doctree
diff --git a/.doctrees/api.calibration/olfactometer.doctree b/.doctrees/api.calibration/olfactometer.doctree
diff --git a/.doctrees/api.calibration/treadmill.doctree b/.doctrees/api.calibration/treadmill.doctree
diff --git a/.doctrees/api.calibration/water_valve.doctree b/.doctrees/api.calibration/water_valve.doctree
diff --git a/.doctrees/api.data_types.doctree b/.doctrees/api.data_types.doctree
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/api.utils.doctree b/.doctrees/api.utils.doctree
diff --git a/.doctrees/articles/core/conventions.doctree b/.doctrees/articles/core/conventions.doctree
diff --git a/.doctrees/articles/core/dataset_structure.doctree b/.doctrees/articles/core/dataset_structure.doctree
diff --git a/.doctrees/articles/data_formats.doctree b/.doctrees/articles/data_formats.doctree
diff --git a/.doctrees/articles/data_formats/harp.doctree b/.doctrees/articles/data_formats/harp.doctree
diff --git a/.doctrees/articles/data_formats/software_events.doctree b/.doctrees/articles/data_formats/software_events.doctree
diff --git a/.doctrees/articles/data_formats/video.doctree b/.doctrees/articles/data_formats/video.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/json_schemas.doctree b/.doctrees/json_schemas.doctree
diff --git a/.doctrees/json_schemas/aind_behavior_data_types.doctree b/.doctrees/json_schemas/aind_behavior_data_types.doctree
diff --git a/.doctrees/json_schemas/aind_behavior_session.doctree b/.doctrees/json_schemas/aind_behavior_session.doctree
diff --git a/.doctrees/json_schemas/aind_behavior_subject_database.doctree b/.doctrees/json_schemas/aind_behavior_subject_database.doctree
diff --git a/.doctrees/json_schemas/aind_manipulator_calibration_logic.doctree b/.doctrees/json_schemas/aind_manipulator_calibration_logic.doctree
diff --git a/.doctrees/json_schemas/aind_manipulator_calibration_rig.doctree b/.doctrees/json_schemas/aind_manipulator_calibration_rig.doctree
diff --git a/.doctrees/json_schemas/load_cells_calibration_logic.doctree b/.doctrees/json_schemas/load_cells_calibration_logic.doctree
diff --git a/.doctrees/json_schemas/load_cells_calibration_rig.doctree b/.doctrees/json_schemas/load_cells_calibration_rig.doctree
diff --git a/.doctrees/json_schemas/olfactometer_calibration_logic.doctree b/.doctrees/json_schemas/olfactometer_calibration_logic.doctree
diff --git a/.doctrees/json_schemas/olfactometer_calibration_rig.doctree b/.doctrees/json_schemas/olfactometer_calibration_rig.doctree
diff --git a/.doctrees/json_schemas/treadmill_calibration_logic.doctree b/.doctrees/json_schemas/treadmill_calibration_logic.doctree
diff --git a/.doctrees/json_schemas/treadmill_calibration_rig.doctree b/.doctrees/json_schemas/treadmill_calibration_rig.doctree
diff --git a/.doctrees/json_schemas/water_valve_calibration_logic.doctree b/.doctrees/json_schemas/water_valve_calibration_logic.doctree
diff --git a/.doctrees/json_schemas/water_valve_calibration_rig.doctree b/.doctrees/json_schemas/water_valve_calibration_rig.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/AindBehaviorSessionModel.svg b/_images/AindBehaviorSessionModel.svg
diff --git a/_sources/api.base.rst.txt b/_sources/api.base.rst.txt
@@ -0,0 +1,15 @@
+base
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   api.base/session
+   api.base/rig
+   api.base/task_logic
+
+
+.. automodule:: aind_behavior_services.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api.base/rig.rst.txt b/_sources/api.base/rig.rst.txt
@@ -0,0 +1,7 @@
+AindBehaviorRigModel
+-------------------------
+
+.. autopydantic_model:: aind_behavior_services.AindBehaviorRigModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api.base/session.rst.txt b/_sources/api.base/session.rst.txt
@@ -0,0 +1,10 @@
+AindBehaviorSessionModel
+--------------------------
+
+.. image:: ../_static/AindBehaviorSessionModel.svg
+   :target: ../_static/AindBehaviorSessionModel.svg
+
+.. autopydantic_model:: aind_behavior_services.session.AindBehaviorSessionModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api.base/task_logic.rst.txt b/_sources/api.base/task_logic.rst.txt
@@ -0,0 +1,7 @@
+AindBehaviorTaskLogicModel
+--------------------------------
+
+.. autopydantic_model:: aind_behavior_services.AindBehaviorTaskLogicModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api.calibration.rst.txt b/_sources/api.calibration.rst.txt
@@ -0,0 +1,124 @@
+calibration
+-------------
+
+Calibration Module
+####################
+
+The calibration module of this library is used to generate the metadata necessary configure and run calibration workflows for different assets/devices.
+
+The metadata follows the general logic of the library by implementing the three core classes:
+   - :py:class:`~aind_behavior_services.session.AindBehaviorSessionModel`
+   - :py:class:`~aind_behavior_services.rig.AindBehaviorRigModel`
+   - :py:class:`~aind_behavior_services.task_logic.AindBehaviorTaskLogicModel`
+
+A fourth class :py:class:`~aind_behavior_services.calibration.Calibration`,
+specific to the Calibration module, is also implemented to keep track of the calibration metrics.
+This class was written to be aligned to the Calibration class in `aind-data-schemas
+<https://github.com/AllenNeuralDynamics/aind-data-schema/blob/2fd0e403bf46f0f1a47e5922c4228517e68376a3/src/aind_data_schema/components/devices.py#L274>`_.
+An application example will be provided below.
+
+While we use the base :py:class:`~aind_behavior_services.session.AindBehaviorSessionModel` class to keep track of the session metadata,
+both :py:class:`~aind_behavior_services.rig.AindBehaviorRigModel` and :py:class:`~aind_behavior_services.task_logic.AindBehaviorTaskLogicModel` are
+expected to be sub-classed to specify the necessary dependencies of the calibration workflow.
+
+Sub-classing :py:class:`~aind_behavior_services.calibration.Calibration`
+##########################################################################
+
+Sub-classing :py:class:`~aind_behavior_services.calibration.Calibration` boils down to providing a subtype of the `input` and `output` fields.
+These fields are expected to be of a sub-type of `~pydantic.BaseModel` and define the structure of the calibration outcome.
+Conceptually, `input` is the pre-process data that resulted from the calibration workflow (i.e. the weight of delivered water),
+whereas `output` is used to represent a post-processed version of the calibration outcome (e.g. a linear model that relates valve-opening times to water volume).
+
+An example of a sub-class of `Calibration` is provided below:
+
+.. code-block:: python
+
+   from pydantic import BaseModel, Field
+   from typing import List, Literal
+   from aind_behavior_services.calibration import Calibration
+
+
+   class BarContainer(BaseModel):
+      baz: string = Field(..., description="Baz value")
+      bar: float = Field(..., description="Bar value")
+
+
+   class DeviceCalibrationInput(BaseModel):
+      measured_foo: List[int] = Field(..., description="Measurements of Foo")
+      bar_container: List[BarContainer] = Field(..., description="Bar container")
+
+
+   class DeviceCalibrationOutput(BaseModel):
+      param_a = float = Field(default=1, description="Parameter A")
+      param_b = float = Field(default=0, description="Parameter B")
+
+
+   class DeviceCalibration(Calibration):
+      device_name: Literal["MyDevice"] = "MyDevice"
+      description: Literal["Stores the calibration of a device"] = "Stores the calibration of a device"
+      input: DeviceCalibrationInput = Field(..., title="Input of the calibration")
+      output: DeviceCalibrationOutput = Field(..., title="Output of the calibration")
+
+Sub-classing :py:class:`~aind_behavior_services.rig.AindBehaviorRigModel`
+##########################################################################
+
+We adopt the following pattern to sub-class the :py:class:`~aind_behavior_services.rig.AindBehaviorRigModel` class:
+
+.. code-block:: python
+
+   from aind_behavior_services.rig import AindBehaviorRigModel, Device
+
+   RIG_VERSION = "1.0.0" # Use SemVer
+
+   class FooDevice(Device):
+      calibration: DeviceCalibration = Field(..., title="Calibration of the device foo")
+
+
+   class CalibrationRig(AindBehaviorRigModel):
+      version: Literal[RIG_VERSION] = RIG_VERSION
+      device_foo: FooDevice = Field(..., title="Device Foo")
+      device_bar: Device = Field(..., title="Device Bar")
+
+
+For an example see :py:class:`aind_behavior_services.calibration.olfactometer.CalibrationRig`.
+
+
+
+Sub-classing :py:class:`~aind_behavior_services.task_logic.AindBehaviorTaskLogicModel`
+########################################################################################
+
+The same way a :py:class:`~aind_behavior_services.task_logic.AindBehaviorTaskLogicModel` is used to define
+the settings to run a behavior task, it is also used to define the settings to run a calibration workflow.
+It will thus follow an identical sub-classing pattern:
+
+
+.. code-block:: python
+
+   from aind_behavior_services.task_logic import AindBehaviorTaskLogicModel, TaskParameters
+
+   TASK_LOGIC_VERSION = "0.1.0"
+
+   class CalibrationParameters(TaskParameters):
+      n_iterations: int = Field(default=10, description="Number of iterations to run the calibration")
+      channels_to_calibrate: List[Literal[1,2,3]] = Field(default=[1], description="List of channels to calibrate")
+
+   class CalibrationLogic(AindBehaviorTaskLogicModel):
+      name: Literal["CalibrationLogic"] = "CalibrationLogic
+      version: Literal[TASK_LOGIC_VERSION] = TASK_LOGIC_VERSION
+      task_parameters: CalibrationParameters = Field(default=CalibrationParameters(), title="Task parameters", validate_default=True)
+
+
+For an example see :py:class:`aind_behavior_services.calibration.olfactometer.CalibrationLogic`.
+
+
+
+.. toctree::
+   :maxdepth: 4
+
+   api.calibration/aind_manipulator
+   api.calibration/load_cells
+   api.calibration/olfactometer
+   api.calibration/water_valve
+   api.calibration/treadmill
+
+
diff --git a/_sources/api.calibration/aind_manipulator.rst.txt b/_sources/api.calibration/aind_manipulator.rst.txt
@@ -0,0 +1,13 @@
+aind_manipulator
+-----------------
+
+.. automodule:: aind_behavior_services.calibration.aind_manipulator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Example
+##########
+
+.. literalinclude:: ../../examples/aind_manipulator.py
+      :language: python
diff --git a/_sources/api.calibration/load_cells.rst.txt b/_sources/api.calibration/load_cells.rst.txt
@@ -0,0 +1,13 @@
+load_cells
+-------------
+
+.. automodule:: aind_behavior_services.calibration.load_cells
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Example
+########
+
+.. literalinclude:: ../../examples/load_cells.py
+      :language: python
diff --git a/_sources/api.calibration/olfactometer.rst.txt b/_sources/api.calibration/olfactometer.rst.txt
@@ -0,0 +1,13 @@
+olfactometer
+-------------
+
+.. automodule:: aind_behavior_services.calibration.olfactometer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Example
+########
+
+.. literalinclude:: ../../examples/olfactometer.py
+      :language: python
diff --git a/_sources/api.calibration/treadmill.rst.txt b/_sources/api.calibration/treadmill.rst.txt
@@ -0,0 +1,15 @@
+treadmill
+-------------
+
+For running the calibration of the treadmill refer to `this repository <https://github.com/AllenNeuralDynamics/harp.device.treadmill/>`_.
+
+.. automodule:: aind_behavior_services.calibration.treadmill
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Example
+########
+
+.. literalinclude:: ../../examples/treadmill.py
+      :language: python
diff --git a/_sources/api.calibration/water_valve.rst.txt b/_sources/api.calibration/water_valve.rst.txt
@@ -0,0 +1,13 @@
+water_valve
+-------------
+
+.. automodule:: aind_behavior_services.calibration.water_valve
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Example
+########
+
+.. literalinclude:: ../../examples/water_valve.py
+      :language: python
diff --git a/_sources/api.data_types.rst.txt b/_sources/api.data_types.rst.txt
@@ -0,0 +1,7 @@
+data_types
+-------------
+
+.. automodule:: aind_behavior_services.data_types
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,10 @@
+API
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   api.base
+   api.calibration
+   api.data_types
+   api.utils
diff --git a/_sources/api.utils.rst.txt b/_sources/api.utils.rst.txt
@@ -0,0 +1,8 @@
+utils
+-------------
+
+
+.. automodule:: aind_behavior_services.utils
+    :members:
+    :undoc-members:
+    :show-inheritance: