... | ... | @@ -3,13 +3,13 @@ |
|
|
# Introduction
|
|
|
The batch_context plugin relies on two types of configuration files in order to correctly handle the job batch.
|
|
|
1. A **Context Config File**
|
|
|
This is a single config text file that specifies local and remote directories and system communications. It is unique to the *user* and the *project*. A user needs to create a new one of these for every project. It is recommended that this file's name includes the project and the user.
|
|
|
This is a single config text file that specifies local and remote directories and system communications. It is unique to the *user* and the *project*. A user needs to create a new one of these for every project. :so: It is recommended that this file's name includes the project and the user.
|
|
|
(ie. *adlofts_eyespilot2016_contextconfig.cfg* )
|
|
|
2. **Batch Config Files**
|
|
|
These are config text files are are unique to each pipeline *script*, but do not need to be changed according to the user or project. These handle the data file identification, pipeline order, software and computing resources of each of the scripts. It is recommended that these are named to mirror their corresponding scripts as they used hand in hand.
|
|
|
These are config text files are are unique to each pipeline *script*, but do not need to be changed according to the user or project. These handle the data file identification, pipeline order, software and computing resources of each of the scripts. :so: It is recommended that these are named to mirror their corresponding scripts as they used hand in hand.
|
|
|
(ie. *S1_Script1.htb* and *C1_Config_for_Script1.cfg* )
|
|
|
|
|
|
If is highly suggested that you always save you config files in the support/config directory as text files. This will make them easy to edit and save outside of the batch_context user interface, as well as having an easy to load file when [Running Scripts](https://git.sharcnet.ca/jdesjard/batch_context/wikis/running-scripts).
|
|
|
:so: It is highly suggested that you always save you config files in the support/config directory as text files. This will make them easy to edit and save outside of the batch_context user interface, as well as having an easy to load file when [Running Scripts](https://git.sharcnet.ca/jdesjard/batch_context/wikis/running-scripts).
|
|
|
# Context configuration files (*.cfg)
|
|
|
A user will need a unique context config file for each project. To get started go to:
|
|
|
* *File -> Context Configuration*
|
... | ... | @@ -73,11 +73,11 @@ A detailed description of each of the fields can be found below: |
|
|
* text
|
|
|
|
|
|
## Saving
|
|
|
Once you have filled out all of the fields click on the |`Save As`| button to save the file. It is recommended that this file's name includes the project and the user. (ie. *adlofts_eyespilot2016_contextconfig.cfg* ) Make sure to place it in support/config directory.
|
|
|
Once you have filled out all of the fields click on the |`Save As`| button to save the file. :so: It is recommended that this file's name includes the project and the user. (ie. *adlofts_eyespilot2016_contextconfig.cfg* ) Make sure to place it in support/config directory.
|
|
|
Now when running a job you can simply load this file and it will populate the required fields for you. You can also use the text file created as a template to quickly edit and create new context config files in a text editor.
|
|
|
|
|
|
# Job configuration files (*.cfg)
|
|
|
There needs to be a unique file created for each script in the pipeline. As the batch config files are not dependant on the project or the user, it is recommended that you only create one local and one remote file for each script. To get started go to:
|
|
|
There needs to be a unique file created for each script in the pipeline. As the batch config files are not dependant on the project or the user, :so: it is recommended that you only create one local and one remote file for each script. To get started go to:
|
|
|
* *File -> Batch -> Batch Configuration*
|
|
|
![smallestcreatebatchconfig](/uploads/48f5df1610f2c60bbad7158a49b01dcd/smallestcreatebatchconfig.png)
|
|
|
|
... | ... | |