diff --git a/docs/html/index.html b/docs/html/index.html index 7a92923d..beedf9c4 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -6,7 +6,7 @@ Rigging Toolbox Documentation

Rigging Toolbox Documentation

Welcome to the main Rigging Toolbox (Rigbox) documentation. Here you can find detailed documentation and guides on how to set up Rigbox, including writing new experiments, setting up recording devices, running experiments and processing the resulting data.

For instructions on how to run the examples from the Rigbox paper, see this guide.

Contents

Installing Rigbox

Below are some instructions for installing Rigbox. There are two guides, the first is a thorough guide for users unfarmilliar with MATLAB and Git. The second is for 'power users' who have a basic understanding of these things.

  1. Detailed install instructions
  2. Installing for power users
  3. Updating the code

Setting up experiments

Below is a set of steps for setting up a full experiment in Rigbox. A full experiment being one where you record quality, reliable data that gets saved into the main experiment repository.

Briefly, before you can run a full experiment you must 1) set up your paths so that Rigbox knows from where to load rig settings and parameters, 2) save a hardware configuration file so that Rigbox can properly initialize its hardware, and 3) locate or create an experiment definition function to define your experiment.

  1. Setting up dat.paths
  2. How to configure hardware on the stimulus computer
  3. Setting up communication between the stimulus computer and MC
  4. Setting up mc and srv.expServer on the same computer
  5. Setting up hardware for the Burgess steering wheel task
  6. Configuring harware for the Burgess steering wheel task

Running full experiments

Before you can run a complete experiment, you must set up Rigbox (see above section). Once this is done there you can follow on of the below sections to run a full experiment.

Creating experiments

The principle way to create a new is experiment (i.e. passive stimulation or behaviour task) is write an expDef. Below will be a set of guides for how to write an expDef, and how to test it.

Working with Rigbox Experiment data

Below are some guides on how to work with the experimental data saved by Rigbox. These guides instruduce some functions for loading and processing these data, and explain the forms in which data are saved.

Troubleshooting

Rigbox is a mountain of code and there are many things that can go wrong when using it. Below are a few guides for how to fix problems that arise in Rigbox.

User guides

Below is a list of in-depth guides for users who want to learn the ins-and-outs of various packages and classes in Rigbox.

Miscellaneous

Below is a list of useful topics:

Etc.

Author: Miles Wells

v0.1.4

Welcome to the main Rigging Toolbox (Rigbox) documentation. Here you can find detailed documentation and guides on how to set up Rigbox, including writing new experiments, setting up recording devices, running experiments and processing the resulting data.

For instructions on how to run the examples from the Rigbox paper, see this guide.

Contents

Installing Rigbox

Below are some instructions for installing Rigbox. There are two guides, the first is a thorough guide for users unfarmilliar with MATLAB and Git. The second is for 'power users' who have a basic understanding of these things.

  1. Detailed install instructions
  2. Installing for power users
  3. Updating the code
  4. Install instructions for using Timeline only

Setting up experiments

Below is a set of steps for setting up a full experiment in Rigbox. A full experiment being one where you record quality, reliable data that gets saved into the main experiment repository.

Briefly, before you can run a full experiment you must 1) set up your paths so that Rigbox knows from where to load rig settings and parameters, 2) save a hardware configuration file so that Rigbox can properly initialize its hardware, and 3) locate or create an experiment definition function to define your experiment.

  1. Setting up dat.paths
  2. How to configure hardware on the stimulus computer
  3. Setting up communication between the stimulus computer and MC
  4. Setting up mc and srv.expServer on the same computer
  5. Setting up hardware for the Burgess steering wheel task
  6. Configuring harware for the Burgess steering wheel task

Running full experiments

Before you can run a complete experiment, you must set up Rigbox (see above section). Once this is done there you can follow on of the below sections to run a full experiment.

Creating experiments

The principle way to create a new is experiment (i.e. passive stimulation or behaviour task) is write an expDef. Below will be a set of guides for how to write an expDef, and how to test it.

Working with Rigbox Experiment data

Below are some guides on how to work with the experimental data saved by Rigbox. These guides instruduce some functions for loading and processing these data, and explain the forms in which data are saved.

Troubleshooting

Rigbox is a mountain of code and there are many things that can go wrong when using it. Below are a few guides for how to fix problems that arise in Rigbox.

User guides

Below is a list of in-depth guides for users who want to learn the ins-and-outs of various packages and classes in Rigbox.

Miscellaneous

Below is a list of useful topics:

Etc.

Author: Miles Wells

v0.1.5

\ No newline at end of file diff --git a/docs/scripts/index.m b/docs/scripts/index.m index 2b01a611..e441720a 100644 --- a/docs/scripts/index.m +++ b/docs/scripts/index.m @@ -5,7 +5,7 @@ % experiments and processing the resulting data. % % For instructions on how to run the examples from the -% , see +% , see % <./paper_examples.html this guide>. %% Installing Rigbox @@ -17,6 +17,7 @@ % # <./install.html Detailed install instructions> % # +% # <./updating_code.html Updating the code> % # <./install_Timeline.html Install instructions for using Timeline only> % @@ -108,9 +109,11 @@ % * <./glossary.html Glossary of Rigbox terminology> % * <./using_visual_stimuli.html Details of the Signals viewing model> % * <./contributing.html How to edit the documentation> +% * <./release_notes_v260.html v2.6.0 release notes> +% * <./release_notes_v270.html v2.7.0 release notes> % %% Etc. % Author: Miles Wells % -% v0.1.3 +% v0.1.5 diff --git a/index.html b/index.html index ecbfec64..beedf9c4 100644 --- a/index.html +++ b/index.html @@ -66,7 +66,7 @@ -

Rigging Toolbox Documentation

Welcome to the main Rigging Toolbox (Rigbox) documentation. Here you can find detailed documentation and guides on how to set up Rigbox, including writing new experiments, setting up recording devices, running experiments and processing the resulting data.

For instructions on how to run the examples from the Rigbox paper, see this guide.

Contents

Installing Rigbox

Below are some instructions for installing Rigbox. There are two guides, the first is a thorough guide for users unfarmilliar with MATLAB and Git. The second is for 'power users' who have a basic understanding of these things.

  1. Detailed install instructions
  2. Installing for power users
  3. Install instructions for using Timeline only

Setting up experiments

Below is a set of steps for setting up a full experiment in Rigbox. A full experiment being one where you record quality, reliable data that gets saved into the main experiment repository.

Briefly, before you can run a full experiment you must 1) set up your paths so that Rigbox knows from where to load rig settings and parameters, 2) save a hardware configuration file so that Rigbox can properly initialize its hardware, and 3) locate or create an experiment definition function to define your experiment.

  1. Setting up dat.paths
  2. How to configure hardware on the stimulus computer
  3. Setting up communication between the stimulus computer and MC
  4. Setting up mc and srv.expServer on the same computer
  5. Setting up hardware for the Burgess steering wheel task
  6. Configuring harware for the Burgess steering wheel task

Running full experiments

Before you can run a complete experiment, you must set up Rigbox (see above section). Once this is done there you can follow on of the below sections to run a full experiment.

Creating experiments

The principle way to create a new is experiment (i.e. passive stimulation or behaviour task) is write an expDef. Below will be a set of guides for how to write an expDef, and how to test it.

Working with Rigbox Experiment data

Below are some guides on how to work with the experimental data saved by Rigbox. These guides instruduce some functions for loading and processing these data, and explain the forms in which data are saved.

Troubleshooting

Rigbox is a mountain of code and there are many things that can go wrong when using it. Below are a few guides for how to fix problems that arise in Rigbox.

  • Basic MATLAB troubleshooting - this guide is for users that are unfamiliar with MATLAB.
  • General troubleshooting - this guide gives a list of steps to follow when an error is encountered.
  • ID index - A list of Rigbox error/warning IDs along with the a detailed description of what they mean and an exhastive list of causes and solutions.
  • FAQ - A list of frequently asked questions regarding problems and pointers to the solutions.
  • Paths conflicts - Some tips on avoiding errors from conflicting paths.

User guides

Below is a list of in-depth guides for users who want to learn the ins-and-outs of various packages and classes in Rigbox.

  • The Data Package - How to query data locations and log experiments using the +dat package.
  • Parameters - How to create and edit experiment parameters.
  • Alyx - How to interact with an Alyx database
  • Timeline - Using Timeline for time alignment
  • The Window class - Using the stimWindow object
  • Clocks - Using the Clock class

Miscellaneous

Below is a list of useful topics:

Etc.

Author: Miles Wells

v0.1.3

Welcome to the main Rigging Toolbox (Rigbox) documentation. Here you can find detailed documentation and guides on how to set up Rigbox, including writing new experiments, setting up recording devices, running experiments and processing the resulting data.

For instructions on how to run the examples from the Rigbox paper, see this guide.

Contents

Installing Rigbox

Below are some instructions for installing Rigbox. There are two guides, the first is a thorough guide for users unfarmilliar with MATLAB and Git. The second is for 'power users' who have a basic understanding of these things.

  1. Detailed install instructions
  2. Installing for power users
  3. Updating the code
  4. Install instructions for using Timeline only

Setting up experiments

Below is a set of steps for setting up a full experiment in Rigbox. A full experiment being one where you record quality, reliable data that gets saved into the main experiment repository.

Briefly, before you can run a full experiment you must 1) set up your paths so that Rigbox knows from where to load rig settings and parameters, 2) save a hardware configuration file so that Rigbox can properly initialize its hardware, and 3) locate or create an experiment definition function to define your experiment.

  1. Setting up dat.paths
  2. How to configure hardware on the stimulus computer
  3. Setting up communication between the stimulus computer and MC
  4. Setting up mc and srv.expServer on the same computer
  5. Setting up hardware for the Burgess steering wheel task
  6. Configuring harware for the Burgess steering wheel task

Running full experiments

Before you can run a complete experiment, you must set up Rigbox (see above section). Once this is done there you can follow on of the below sections to run a full experiment.

Creating experiments

The principle way to create a new is experiment (i.e. passive stimulation or behaviour task) is write an expDef. Below will be a set of guides for how to write an expDef, and how to test it.

Working with Rigbox Experiment data

Below are some guides on how to work with the experimental data saved by Rigbox. These guides instruduce some functions for loading and processing these data, and explain the forms in which data are saved.

Troubleshooting

Rigbox is a mountain of code and there are many things that can go wrong when using it. Below are a few guides for how to fix problems that arise in Rigbox.

  • Basic MATLAB troubleshooting - this guide is for users that are unfamiliar with MATLAB.
  • General troubleshooting - this guide gives a list of steps to follow when an error is encountered.
  • ID index - A list of Rigbox error/warning IDs along with the a detailed description of what they mean and an exhastive list of causes and solutions.
  • FAQ - A list of frequently asked questions regarding problems and pointers to the solutions.
  • Paths conflicts - Some tips on avoiding errors from conflicting paths.

User guides

Below is a list of in-depth guides for users who want to learn the ins-and-outs of various packages and classes in Rigbox.

  • The Data Package - How to query data locations and log experiments using the +dat package.
  • Parameters - How to create and edit experiment parameters.
  • Alyx - How to interact with an Alyx database
  • Timeline - Using Timeline for time alignment
  • The Window class - Using the stimWindow object
  • Clocks - Using the Clock class

Miscellaneous

Below is a list of useful topics:

Etc.

Author: Miles Wells

v0.1.5

\ No newline at end of file