Documentation... authored by Brad Kennedy's avatar Brad Kennedy
**Tables of Contents**
[[_TOC_]]
# Abstract
The batch_context extension for EEGLAB provides and interface for generating data
processing pipelines and executing them on multiple data files either locally or
......@@ -15,19 +19,19 @@ remote server addresses and facilitates working with a remote environments.
# Page Navigation
**Batch Context Main Components**
* [Script Files](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/script-files)
* [Configuration Files](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/configuration-files)
* [Running Pipelines](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/running-scripts)
* [Script Files](script-files)
* [Configuration Files](configuration-files)
* [Running Pipelines](running-scripts)
**Batch Context Design**
* [Functions](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/functions)
* [Functions](functions)
**Reference and Help**
* [Operating Systems and Remote Submissions](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/operating-systems)
* [Tutorial Packages](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/tutorials)
* [Managing Remote Projects](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/remote-start-up)
* [Adv. String Swapping Techniques](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/adv-str-swap)
* [Contributing and Contacting Us](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/contributing)
* [Operating Systems and Remote Submissions](operating-systems)
* [Tutorial Packages](tutorials)
* [Managing Remote Projects](remote-start-up)
* [Adv. String Swapping Techniques](adv-str-swap)
* [Contributing and Contacting Us](contributing)
# Tutorials and Best Practice
There are three symbols that you should keep an eye out for in this documentation:
......@@ -42,14 +46,14 @@ There are three symbols that you should keep an eye out for in this documentatio
# Getting Started!
Running a successful job using batch context consists of 5 main components:
1. Data Files
2. [History Batch Files (Scripts)](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/script-files)
3. [Batch Configuration Files](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/configuration-files)
4. [Context Configuration File](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/configuration-files)
5. [Local or Remote Computing Resources ](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/running-scripts)
2. [History Batch Files (Scripts)](script-files)
3. [Batch Configuration Files](configuration-files)
4. [Context Configuration File](configuration-files)
5. [Local or Remote Computing Resources ](running-scripts)
All of these components will need to be selected and/or loaded into the main batch context user interface before the batch can be executed. Running your data files in a batch is an effective way to execute scripted pipelines, modules or procedures on large sets of data files.
:so: Download the [Tutorial Pipeline](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/tutorials) and work your way through the wiki pages. If you want to get right to running a job go to [Running scripts](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/running-scripts) and use :b: provided files.
:so: Download the [Tutorial Pipeline](tutorials) and work your way through the wiki pages. If you want to get right to running a job go to [Running scripts](running-scripts) and use :b: provided files.
![overveiwallcolor](/uploads/6d4cc7aaaef80e191998f4d27453c7b2/overveiwallcolor.png)
......@@ -85,4 +89,4 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA*
*Updated/Verified by Brad Kennedy on 2017-08-01*
[ :arrow_up: Top of Page](https://git.sharcnet.ca/bucanl_eeglab_extensions/batch_context/wikis/home)
\ No newline at end of file
[ :arrow_up: Top of Page](home)
\ No newline at end of file