Skip to content

Commit 9f5a456

Browse files
author
Jai
committed
started updating README after Anwar's comments
1 parent 10dc661 commit 9f5a456

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,18 @@
33
![Coverage badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgladius.serveo.net%2Fcoverage%2Frigbox%2Fdev)
44
![Build status badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgladius.serveo.net%2Fstatus%2Frigbox%2Fdev)
55

6-
Rigbox is a high-performance, open-source MATLAB toolbox for managing behavioral neuroscience experiments. Initially developed to probe mouse behavior for the [Steering Wheel Setup](https://www.ucl.ac.uk/cortexlab/tools/wheel), Rigbox simplifies hardware/software interfacing and creates a runtime environment in which an experiment's parameters can be easily monitored and manipulated.
6+
Rigbox is a high-performance, open-source toolbox for managing behavioral neuroscience experiments. Initially developed to probe mouse behavior for the [Steering Wheel Setup](https://www.ucl.ac.uk/cortexlab/tools/wheel), Rigbox's main goals are to simplify hardware/software interfacing, visual and auditory stimuli presentation, and behavioral task design and implementation, by allowing users to progrmatically define behavioral tasks whose parameters can be easily monitored and manipulated. Additionally, Rigbox can time-align data streams from multiple sources and communicate with a remote database to manage experiment data.
77

8-
Rigbox includes many features including synchronizing recordings, managing experimental data and a viewing model for visual stimuli.
9-
10-
Rigbox is mostly object-oriented and highly modular, making designing new experiments much simpler. Rigbox is currently under active, test-driven development.
8+
Rigbox is mostly object-oriented and highly modular, which simplifies the process of designing both new and iterative experiments. Rigbox is run in MATLAB with some Java components that handle network communication and a C library to boost performance. Rigbox is currently under active, test-driven development.
119

1210
## Getting Started
1311

14-
The following is a brief description of how to install Rigbox on your experimental rig. Detailed, step-by-step information can be found in Rigbox's [documentation](https://github.com/cortex-lab/Rigbox/tree/master/docs). Information specific to the steering wheel task can be found on the [CortexLab website](https://www.ucl.ac.uk/cortexlab/tools/wheel).
12+
The following is a brief description of Rigbox's requirements and installation and getting started instructions. For exploring Rigbox's features and running test experiments, Rigbox only needs to be installed on a single computer. However, for running complete experiments, Rigbox must be installed on two computers: one computer communicates with an experiment rig's hardware and presents stimuli (which we refer to as the "Stimulus Computer" or "SC"), and the other computer the user interacts with to start, stop, monitor, and parameterize the experiment (which we refer to as the "Master Computer", or "MC"). Detailed, step-by-step information can be found in Rigbox's [documentation](https://github.com/cortex-lab/Rigbox/tree/master/docs). Information specific to the steering wheel task can be found on the [CortexLab website](https://www.ucl.ac.uk/cortexlab/tools/wheel).
1513

1614
### Requirements
1715

18-
For running full experiments Rigbox requires two PCs: one for presenting stimuli and one for monitoring the experiment. Currently only National Instruments DAQs are supported for acquiring data from hardware devices. For testing, the toolbox can be run on a single machine.
16+
#### Software
1917

20-
Rigbox has the following software dependencies:
2118
* Windows Operating System (7 or later, 64-bit)
2219
* MATLAB (2017b or later)
2320
* [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-us/download/details.aspx?id=40784) <for Signals>
@@ -37,6 +34,9 @@ Additionally, Rigbox works with a number of extra submodules (included):
3734
* [npy-matlab](https://github.com/kwikteam/npy-matlab) (for saving data in binary NPY format)
3835
* [wheelAnalysis](https://github.com/cortex-lab/wheelAnalysis) (for analyzing data from the steering wheel task)
3936

37+
#### Hardware
38+
@todo fill in hardware requirements section.
39+
4040
### Installation
4141

4242
It is highly recommended to install Rigbox via the [Git Bash](https://git-scm.com/download/win) terminal*.
@@ -96,9 +96,9 @@ When calling `srv.expServer` and `mc`, the code is automatically updated if a ne
9696
## Acknowledgements
9797

9898
* [GUI Layout Toolbox](https://uk.mathworks.com/matlabcentral/fileexchange/47982-gui-layout-toolbox) for code pertaining to Rigbox's UI
99-
* [Psychophsics Toolbox](http://psychtoolbox.org) for code pertaining to visual stimulus presentation
99+
* [Psychophsics Toolbox](http://psychtoolbox.org) for code pertaining to visual and auditory stimulus presentation
100100
* [NI-DAQmx](https://uk.mathworks.com/hardware-support/nidaqmx.html) for code pertaining to inerfacing with a NI-DAQ device
101-
* [TooTallNate](https://github.com/TooTallNate/Java-WebSocket) for code pertaining to using Java Websockets
101+
* [TooTallNate](https://github.com/TooTallNate/Java-WebSocket) for code pertaining to using Java Websockets to handle network communication between 'MC' and 'SC'.
102102

103103
## Contributing
104104

0 commit comments

Comments
 (0)