From 3b4a4c14ba1e9371728ccf60a3bcaa3263ca2e5b Mon Sep 17 00:00:00 2001 From: Guillaume PHILIPPON Date: Mon, 6 Apr 2015 11:24:15 +0200 Subject: [PATCH] Add some documentation --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c90a1e9..16af867 100644 --- a/README.md +++ b/README.md @@ -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