Quick Start
==========================

Installation of AutoHeadFix
-----------------------------

To downlowd the setup script for AutoHeadFix, `click here  <https://github.com/ubcbraincircuits/AHF_setup>`_.

**Installation Walk Through**

.. raw:: html

        <video width="640" height="360" controls>
        <source src="setup_script.mp4">
           type="video/mp4">
           Your browser does not support this video type.
        </video>

**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.

|

.. Developers
.. ---------------

.. * For notes and structure information from the developer, `click here <https://Judge24601.github.io/AutoHeadFix/AHF_Notes.html>`_.
.. * To clone the source code, `click here <https://github.com/ubcbraincircuits/AutoHeadFix>`_.


Contributing
--------------------------------

To clone the source code, `click here <https://github.com/ubcbraincircuits/AutoHeadFix>`_. Please request access by conctacting UBC Brain Circuits at :code:`brain.circuits@ubc.ca` or create a fork of the project.

Documentation can be found in the :code:`docs` folder. The documentations is built with `Sphinx <https://www.sphinx-doc.org/en/master/>`_, which can be installed through `apt, conda, or pip <https://www.sphinx-doc.org/en/master/usage/installation.html>`_

Minor changes can be included directly in the docstrings of the relevant :code:`.py` files; major changes can be made by modifying the :code:`.rst` files.  Run :code:`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**

.. raw:: html

        <video width="640" height="360" controls>
        <source src="configs.mp4">
           type="video/mp4">
           Your browser does not support this video type.
        </video>

|

**Generic Usage Guide**

.. raw:: html

        <video width="640" height="360" controls>
        <source src="AutoHeadFixGuide.mp4">
           type="video/mp4">
           Your browser does not support this video type.
        </video>

|

**Cron Creation**

.. raw:: html

        <video width="640" height="360" controls>
        <source src="cronSetup.mp4">
           type="video/mp4">
           Your browser does not support this video type.
        </video>

|

**Changing Mouse Specific Var**

.. raw:: html

        <video width="640" height="360" controls>
        <source src="changeMouseSpecificVar.mp4">
           type="video/mp4">
           Your browser does not support this video type.
        </video>

|

**Training Difficulty**

.. raw:: html

        <video width="640" height="360" controls>
        <source src="training.mp4">
           type="video/mp4">
           Your browser does not support this video type.
        </video>