README.md

Classes

Map Class

Map class represents the physical layout of the box, and has access to all of the physical (or simulated) objects that control the box. Map class packages up all of the hardware objects into a single object that can be accessed by a Control Mode or a Simulation Script. 

<aps are made up of a series of Vertices and Edges, where the Vertices are represented by the Chamber class and the Edges are represented by the Edge class. 

Example: Operant Map

graph LR
A[Chamber1] -- Edge12 --- B[Chamber2]
C[Chamber3] -- Edge13  --- A

Loading

All hardware components are assigned to a location within an edge or chamber. A component comes in two forms: a plain Component class or a ComponentSet. A Component class contains a singular interactable. Every interactable is some subclass of InteractableABC. A ComponentSet, on the otherhand, is assigned to every chamber and contains a set of interactables. In the below example, the food_dispenser and water belong to a ComponentSet, because the order that a vole accesses these is not important. Any interactable that an edge references, or exists on an edge is contained by a Component object, because the order that vole accesses these does matter. 

Example: Home Cage Map

flowchart LR
    subgraph Chamber1[Food Chamber]
        direction LR
        food_dispenser/trough
        water
    end
    subgraph Edge12[Connecting Tunnel]
        direction TB
        ir_beam1
        door1
        rfid
        door2
        ir_beam2
    end 
    subgraph Chamber2[Reward Chamber]
        direction LR
        Wheel 
    end
    Chamber1 --- Edge12 --- Chamber2

Loading

InteractableABC

The abstract class that all other interactables inherit from.

ModeABC

The abstract class that all mode scripts inherit from.

EventManager

Class for recording event data and performing thread safe printing.