Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add license document and license text to code. Add simple README file.
- Loading branch information
1 parent
b3bad87
commit b2489cb
Showing
8 changed files
with
783 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# A Simple SGE Template Preprocessor Engine | ||
|
||
|
||
`qsubsec` is a template language for generating script files for submission using the [SGE grid system](https://arc.liv.ac.uk/trac/SGE). By using this system, you can separate the logic of your qsub jobs from the data required for a specific run. | ||
|
||
## Overview | ||
|
||
The qsubsec utility processes qsubsec-formatted template files to generate code sections that can be submitted for execution (for example through the SGE scheduler). Before processing, template files are checked for token placeholders and these are filled in. The resulting Python code is then executed to generate a set of sections. | ||
|
||
The stages in template processing are: | ||
|
||
* The template file and token file(s) are read; | ||
* Any token placeholders found in the template file are filled in using the tokens file(s) read; | ||
* The resulting Python code is executed to yield a set of sections; | ||
* Each section is output in turn | ||
|
||
Processed sections can be output in multiple formats (currently `bash` and `qsub`), allowing the same templates to be run on multiple different systems. | ||
|
||
For more information on the TFF token definition syntax and the qsubsec template syntax, see the documentation directory. | ||
|
||
|
||
## Installation | ||
|
||
Installation should be as simple as: | ||
|
||
~~~bash | ||
git clone https://github.com/alastair-droop/qsubsec3.git | ||
cd qsubsec3 | ||
python setup.py install | ||
~~~ | ||
|
||
Although `qsubsec` can be run on most machines, the qsub executable must be available and functional for automatic qsub submission to work (using the `-s` argument with the qsub format). | ||
|
||
## Licence | ||
|
||
These tools are released under the [GNU General Public License version 3](http://www.gnu.org/licenses/gpl.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters