Skip to content

Commit

Permalink
Add some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
guillaume-philippon committed Apr 6, 2015
1 parent bdfb8a3 commit 3b4a4c1
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# Condor-Submit
A python script to avoid .sub description file to start job on HTCondor cluster
# Condor-Tools
A set of python script to interact with HTCondor cluster

## csub
csub is a submit script. It allow user to avoid .sub file creation to submit job to HTCondor.
The simplest usage of csub it's job the name of the binary you want launch

user@machine> csub /path/to/script

All options are available with the command --help

user@machine> csub --help
usage: csub [-h] [--args ARGUMENTS] [--group GROUP] [--machine MACHINE]
[--input INPUT_FILES] [--output OUTPUT_FILES] [--cpus CPUS]
script

Condor submit wrapper to improve user experience

positional arguments:
script /path/to/script you want run

optional arguments:
-h, --help show this help message and exit
--args ARGUMENTS Arguments for your script
--group GROUP Condor group you want to use (based on Unix group)
--machine MACHINE Define a specific machine you want use (should be the
full hostname of the machine)
--input INPUT_FILES A list of input file
--output OUTPUT_FILES
A list of output file
--cpus CPUS Number of CPUs you need

0 comments on commit 3b4a4c1

Please sign in to comment.