Autopilot Logo
latest

User Guide:

  • Overview
    • Program Structure
    • Tasks
    • Module Tour
  • Quickstart
    • Minimal Installation
    • Blink an LED
    • Capture Video
    • Communicate Between Computers
    • Realtime DeepLabCut
    • Put it Together - Close a Loop!
      • Pilot 1 - Image Capture
      • GPU Computer
      • Pilot 2 - LED
    • What Next?
  • Installation
    • Supported Systems
    • Pre-installation
      • On the Pilot device
      • On the Terminal device
    • Installing Autopilot
      • Optional dependencies
      • Method 1: Installation from PyPI
      • Method 2: Installation from source
  • Configuration
    • Guided Configuration
      • Select Agent
      • Select scripts
      • Configure Agent
      • Configure Hardware
      • Testing the Installation
    • The User Directory
      • prefs.json
      • pilot_db.json
      • launch_autopilot.sh
      • calibration
      • data
      • logs
      • plugins
      • protocols
      • sounds
    • Networking
      • IP Addresses
      • Ports
  • Training a Subject
    • Connecting the Pilot
    • Creating a Protocol
      • Using the Protocol Wizard
      • Manual Protocol Creation
    • Creating a Subject
    • Running the Task
    • Debugging a Task
  • Writing a Task
    • The Task class
    • Four Task Attributes
      • PARAMS
      • Data
      • PLOT
      • HARDWARE
    • Initialization
    • Stage Methods
      • Request
      • Discrim
      • Reinforcement
    • Additional Methods
  • Using Plugins
    • Plugins
    • Registries
    • The Wiki API
    • Plugins on the Wiki
  • Examples
    • Blink
      • Preamble
        • Params
        • TrialData
        • Hardware
      • Initialization
      • Stage Methods
      • Full Source
    • Distributed Go/No-Go
      • Additional Prefs
      • Go/No-Go Parameterization
      • Initialization
      • The Child Task
      • A Very Smart Wheel
      • Go/No-Go Stage Methods
  • FAQ
    • Getting Help
    • Networking
    • Contributing
    • Using Python
      • Using Virtual Environments

API Documentation:

  • Agents
    • base
    • pilot
    • terminal
  • Data
    • subject
    • interfaces
      • base
      • tables
      • datajoint
      • nwb
    • modeling
    • models
      • biography
      • protocol
      • researcher
      • subject
    • units
  • GUI
    • menus
    • Plots
      • plot
      • geom
      • info
      • video
    • widgets
      • input
      • model
      • protocol
      • subject
      • terminal
      • list
    • dialog
  • Hardware
    • cameras
    • gpio
    • i2c
    • usb
  • Networking
    • station
    • node
    • Message
  • Stimuli
    • managers
    • sound
      • jackclient
      • pyoserver
      • base - sound
      • sounds
  • Tasks
    • task
    • children
    • free_water
    • graduation
    • nafc
  • Transformations
    • Coercion
    • Geometry
    • Image
    • Logical
    • Selection
    • Timeseries
    • Units
  • Utilities
    • Common Utils
    • Decorators
    • Hydration
    • GUI Invoker
    • loggers
    • Log Parsers
    • Plugins
    • Registry
    • Requires
    • Types
    • Wiki
  • Setup
    • scripts
    • run_script
  • Prefs
  • Root
  • External

Meta:

  • Wiki
  • Discussion
  • Changelog
    • Version 0.5
      • v0.5.0a0 - ~The Data Modeling Edition~
        • Upgrading From <v0.5.0
        • Package Structure
        • Major updates
        • Minor updates
        • Bugfixes
        • Regressions
        • Prefs
        • Packaging & Dependencies
        • Docs
        • Tests
    • Version 0.4
      • v0.4.4 - Timing and Sound (February 2nd, 2022)
        • New
        • Improvements
        • Bugfixes
        • Docs
      • v0.4.3 (October 20th, 2021)
        • New Features
        • Minor Improvements
        • Bugfixes
      • v0.4.2 (August 24th)
        • Minor Improvements
        • Bugfixes
        • Documentation
      • v0.4.1 (August 17th)
        • Bugfixes
        • Docs
      • v0.4.0 - Become Multifarious (August 3rd, 2021)
        • New Features
        • Major Improvements
        • Minor Improvements
        • Bugfixes
        • Code Structure
        • Docs
        • Regressions
    • Version 0.3
      • v0.3.5 (February 22, 2021)
        • Bugfixes
      • v0.3.4 (December 13, 2020)
        • Improvements
        • Bugfixes
        • Docs
        • Logging
      • v0.3.3 (October 25, 2020)
        • Bugfixes
        • Improvements
        • Cleanup
      • v0.3.2 (September 28, 2020)
        • Bugfixes
        • Cleanup
      • v0.3.1 (August 4, 2020)
      • v0.3.0 (August 4, 2020)
        • Major Updates
        • Minor Updates
        • New Features
        • Bugfixes
        • Code Structure
        • External Libraries
        • Regressions
    • Version 0.2
      • v0.2.0 (October 26, 2019)
  • To-Do
    • Visions
      • Integrations
        • Open Ephys Integrationpriority: high | discuss>>
        • Multiphoton & High-performance Image Integrationpriority: high | discuss>>
        • Bonsai Integrationpriority: low | discuss>>
      • Closed-Loop Behavior & Processing Pipelines
    • Improvements
    • Bugs
    • Completed
    • Lowest Priority
  • References

Tests:

  • Tests
    • Networking
    • Plugins
    • Prefs
    • Registry
    • Setup
    • Sounds
    • Terminal
    • Transforms
    • Utils
Autopilot
  • »
  • stim
  • Edit on GitHub

stim

  • managers
  • sound
    • jackclient
    • pyoserver
    • base - sound
    • sounds
Previous Next

© Copyright 2019, Jonny Saunders. Revision 04b5968b.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
v0.5.0
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.1
v0.4.0
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
parallax
main
hotfix
gammatone
dev
detour-datamodel
Downloads
pdf
On Read the Docs
Project Home
Builds