... | ... | @@ -9,19 +9,20 @@ This is a single config text file that specifies local and remote directories an |
|
|
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.
|
|
|
(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 the Scripts]
|
|
|
|
|
|
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 the Scripts](https://git.sharcnet.ca/jdesjard/batch_context/wikis/running-scripts)
|
|
|
# Context configuration files (*.cfg)
|
|
|
A user will need a unique
|
|
|
Context
|
|
|
* *File -> Batch -> Run History Template Batch*
|
|
|
A user will need a unique context config file for each project. To get started go to:
|
|
|
* *File -> Context Configuation*
|
|
|
![smallestcreatecontextconfig](/uploads/d1632e0d4616b94e5235e3cca0821112/smallestcreatecontextconfig.png)
|
|
|
|
|
|
## Editing
|
|
|
text
|
|
|
![smallestcreatecontextconfig](/uploads/d1632e0d4616b94e5235e3cca0821112/smallestcreatecontextconfig.png)
|
|
|
text
|
|
|
![contextedit](/uploads/936947f6c07f2c7ba518432524a44d4d/contextedit.png)
|
|
|
## Editing
|
|
|
You can create a new or edit and old context config in this user interface. To load an existing config file click on the |`Load Context Config`| button. You will need to fill out a number of fields depending on whether you will be running the job locally or remotely. All jobs must fill out the local dependancy feilds at the top of the block.
|
|
|
![contextedit](/uploads/936947f6c07f2c7ba518432524a44d4d/contextedit.png)
|
|
|
***
|
|
|
A detailed description of each of the fields can be found below:
|
|
|
***
|
|
|
*Required for All Jobs*
|
|
|
***
|
|
|
**1. Log Path**
|
|
|
* text
|
|
|
|
... | ... | @@ -34,6 +35,9 @@ text |
|
|
* text
|
|
|
|
|
|
***
|
|
|
*Only Required for Remote Jobs*
|
|
|
***
|
|
|
|
|
|
|
|
|
**4. Username for the Remote Host**
|
|
|
* text
|
... | ... | @@ -69,9 +73,10 @@ text |
|
|
* text
|
|
|
|
|
|
## Saving
|
|
|
text
|
|
|
## Loading
|
|
|
text
|
|
|
Once you have filled out all of the fields click `Save As` 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.
|
|
|
Now when running a job your 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)
|
|
|
text
|
|
|
## Editing
|
... | ... | |