aahana1 / neurodot Goto Github PK

NEURODOT README

Table of Contents:

1. Installation
2. Getting Started
3. Reference Material


1. Installation

Note: NeuroDOT is optimized for use in MATLAB 2020b on Windows and Unix. If you do not have MATLAB, contact your IT department or go to www.mathworks.com for more information on MATLAB. Your results may vary with other versions or operating systems.

To install NeuroDOT, copy the unzipped folder into the directory of your choosing. Then open MATLAB and either click on the "Set Path" button on the "Home" tab of the main MATLAB console, or copy and paste the following command into your command line, substituting the bracketed words for the path into which you unzipped NeuroDOT:

addpath(genpath('[INSTALL DRIVE AND PATH]\NeuroDOT\'))


2. Getting Started

The toolbox contains 4 folders: Data, Documentation, Functions, and Support_Files. In the Documentation folder you will find the User Manual, the Overview, and the  Tutorials. These will give you all the basic information needed to work with fNIRS data in NeuroDOT. Additionally, there are scripts in the Documentation/Scripts folder that cover all of the material in the various Tutorials.


3. Reference Material

Also within the "Documentation" folder are several other tutorial appendices for beginner and advanced users, function reference files, and extended versions of each tutorial that can be viewed in the MATLAB Help Viewer. Additionally, for any function in NeuroDOT, you can type "help [function name]" into the MATLAB command line and view the function reference that way.


4. We are still adding to the toolbox, so please do not hesitate to reach out if you have questions. (Emma Speh: [email protected], Ari Segel: [email protected], Adam Eggebrecht: [email protected])