iblrig
  • Installation guide
  • Using IBLRIG v8
  • Reference
  • Hardware Guide
  • Developer Guide
  • Frequently Asked Questions
  • API Reference
    • iblrig
      • iblrig.base_choice_world
      • iblrig.base_tasks
      • iblrig.choiceworld
      • iblrig.commands
      • iblrig.constants
      • iblrig.ephys
      • iblrig.frame2ttl
      • iblrig.gui
      • iblrig.hardware
      • iblrig.hardware_validation
      • iblrig.hifi
      • iblrig.misc
      • iblrig.net
      • iblrig.neurophotometrics
      • iblrig.online_plots
      • iblrig.path_helper
      • iblrig.pydantic_definitions
        • iblrig.pydantic_definitions.ExistingFilePath
        • iblrig.pydantic_definitions.BunchModel
        • iblrig.pydantic_definitions.HardwareSettings
        • iblrig.pydantic_definitions.HardwareSettingsBpod
        • iblrig.pydantic_definitions.HardwareSettingsCamera
        • iblrig.pydantic_definitions.HardwareSettingsCameraWorkflow
        • iblrig.pydantic_definitions.HardwareSettingsFrame2TTL
        • iblrig.pydantic_definitions.HardwareSettingsMicrophone
        • iblrig.pydantic_definitions.HardwareSettingsNeurophotometrics
        • iblrig.pydantic_definitions.HardwareSettingsRotaryEncoder
        • iblrig.pydantic_definitions.HardwareSettingsScale
        • iblrig.pydantic_definitions.HardwareSettingsScreen
        • iblrig.pydantic_definitions.HardwareSettingsSound
        • iblrig.pydantic_definitions.HardwareSettingsValve
        • iblrig.pydantic_definitions.RigSettings
        • iblrig.pydantic_definitions.TrialDataModel
      • iblrig.raw_data_loaders
      • iblrig.rig_component
      • iblrig.scale
      • iblrig.serial_singleton
      • iblrig.session_creator
      • iblrig.sound
      • iblrig.tools
      • iblrig.transfer_experiments
      • iblrig.upgrade_iblrig
      • iblrig.valve
      • iblrig.version_management
      • iblrig.video
      • iblrig.video_pyspin
    • iblrig_tasks
  • Changelog

Links

  • IBLRIG on GitHub
  • Appendix 3: IBL protocol for setting up the behavioral training rig
iblrig
  • API Reference
  • iblrig
  • iblrig.pydantic_definitions
  • View page source

iblrig.pydantic_definitions

Module Attributes

ExistingFilePath

Validate that path exists and is file.

Classes

BunchModel

HardwareSettings

HardwareSettingsBpod

HardwareSettingsCamera

HardwareSettingsCameraWorkflow

HardwareSettingsFrame2TTL

HardwareSettingsMicrophone

HardwareSettingsNeurophotometrics

HardwareSettingsRotaryEncoder

HardwareSettingsScale

HardwareSettingsScreen

HardwareSettingsSound

HardwareSettingsValve

RigSettings

TrialDataModel

A data model for trial data that extends BaseModel.

Previous Next

© Copyright 2018 – 2025 International Brain Laboratory.

Built with Sphinx using a theme provided by Read the Docs.