Quick Start

Installation of AutoHeadFix

To downlowd the setup script for AutoHeadFix, click here.

Installation Walk Through

Important:

  • Having multiple installations can cause things to break if this is not your first time running this script in the trash make sure to delete all old folders and empty your trash

  • A config.txt file will be included in the repository, you must change the variables (eg path, password) to your installation specific details.

  • All cageID’s must be unique.


Contributing

To clone the source code, click here. Please request access by conctacting UBC Brain Circuits at brain.circuits@ubc.ca or create a fork of the project.

Documentation can be found in the docs folder. The documentations is built with Sphinx, which can be installed through apt, conda, or pip

Minor changes can be included directly in the docstrings of the relevant .py files; major changes can be made by modifying the .rst files. Run make clean; make html to rebuild html files after making changes. Do not modify html files directly, as they will be overwritten.

Please make sure to update docs as soon as changes are finalised! Ensure docs and code are updated in a single commit to prevent mismatches and outdated documentation.


Usage

First Time Configuration


Generic Usage Guide


Cron Creation


Changing Mouse Specific Var


Training Difficulty