diff --git a/README.md b/README.md index 617ff12..8c02b37 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,30 @@ Submit a job that needs 8 CPUs $ ssubmit -m 16g -t 1d align "minimap2 -t 8 ref.fa query.fq > out.paf" -- -c 8 ``` +``` +$ ssubmit -h +Submit sbatch jobs without having to create a submission script + +Usage: ssubmit [OPTIONS] [-- ...] + +Arguments: + Name of the job + Command to be executed by the job + [REMAINDER]... Options to be passed on to sbatch + +Options: + -o, --output File to write job stdout to. (See `man sbatch | grep -A 3 'output='`) [default: %x.out] + -e, --error File to write job stderr to. (See `man sbatch | grep -A 3 'error='`) [default: %x.err] + -m, --mem Specify the real memory required per node. e.g., 4.3kb, 7 Gb, 9000, 4.1MB become 5KB, 7000M, 9000M, and 5M, respectively [env: SSUBMIT_MEMORY=] [default: 1G] + -t, --time