-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the visprotocol wiki!
This wiki contains guides for using, configuring, and extending visprotocol for your lab or user-specific use cases. Once you have installed and tested the visprotocol core (i.e. this repository), you can get started with a lab or user package.
It is recommended that you start with the template lab package repository, and create a fork of it, giving it a unique, meaningful-to-you name. For example, here in the Clandinin lab we called ours clandininlab_package
**Note: Github does not allow you to change the visibility of a forked repository, so if you want your lab-specific repository to be private, you can use this repository importer tool. Simply enter https://github.com/mhturner/lab_package as the clone URL, tell github where you want the imported repository to live, and set its permissions.
To add lab and user-specific functionality, visprotocol looks for a file called visprotocol/path_to_lab_package.txt. The first time you run the ExperimentGUI it will look for this file, and if it doesn't find it, it will create it for you. Edit this file to reflect the local path to your lab package repository.
visprotocol is configured by .yaml configuration files, which should be kept in lab_package/configs
See an example configuration file in the template lab package here.
Once you have pointed visprotocol to the lab_package repository using the path_to_lab_package.txt file, starting the ExperimentGUI will first bring up a selection window which allows you to select which configuration file and rig configuration you want for this experiment. The list of available configurations is set by the .yaml files found in lab_package/configs