From 9f855082f2d3a232f0c3b62ce35b475a49ac1d41 Mon Sep 17 00:00:00 2001 From: Mathieu Germain Date: Fri, 13 Mar 2015 14:26:17 -0400 Subject: [PATCH] Update README.md Typo + rephrasing. --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a9774db..438cc65 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ [![Build Status](https://travis-ci.org/SMART-Lab/smartdispatch.png)](https://travis-ci.org/SMART-Lab/smartdispatch) -[![Coverage Status](https://coveralls.io/repos/SMART-Lab/smartdispatch/badge.png)](https://coveralls.io/r/SMART-Lab/smartdispatch) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/SMART-Lab/smartdispatch/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/SMART-Lab/smartdispatch/?branch=master) +[![Coverage Status](https://coveralls.io/repos/SMART-Lab/smartdispatch/badge.png)](https://coveralls.io/r/SMART-Lab/smartdispatch) # Smart Dispatch An easy to use job launcher for supercomputers with PBS compatible job manager. ## Features - Launch multiple jobs with a single line. -- Automactically generate combinations of arguments. *(see examples)* -- Automatic ressource management. Determine for you the optimal fit for your commands on nodes. +- Automatically generate combinations of arguments. *(see examples)* +- Automatic resources management. Determine for you the optimal fit for your commands on nodes. - Resume batch of commands. - Easily manage logs. - Advanced mode for complete control. @@ -20,21 +20,22 @@ An easy to use job launcher for supercomputers with PBS compatible job manager. ## Usage See `smart_dispatch.py --help` -Output and error logs in are saved in : `./SMART_DISPATCH_LOGS/{batch_id}/logs/`. + +Output and error logs in are saved in : *`./SMART_DISPATCH_LOGS/{batch_id}/logs/`*. ## Examples -###Launch Job +### Launch job `smart_dispatch.py -q qtest@mp2 launch python my_script.py 2 80 tanh 0.1` -This will launch `python my_script.py 2 80 tanh 0.1` on the queue qtest@mp2. +Will launch *`python my_script.py 2 80 tanh 0.1`* on the queue qtest@mp2. -###Launch Jobs Batch -Automactically generate commands from combinations of arguments. +### Launch batch of jobs +Automatically generate commands from combinations of arguments. `smart_dispatch.py -q qtest@mp2 launch python my_script.py [1 2] 80 [tanh sigmoid] 0.1` -This will generate 4 different commands and launch them on the queue qtest@mp2: +Will generate 4 different commands and launch them on the queue qtest@mp2: ``` python my_script.py 1 80 sigmoid 0.1 python my_script.py 1 80 tanh 0.1 @@ -42,7 +43,9 @@ python my_script.py 2 80 sigmoid 0.1 python my_script.py 2 80 tanh 0.1 ``` -###Resuming Job -Given the `batch_id` (i.e. folder's name in `SMART_DISPATCH_LOGS/{batch_id}/`) one can relaunch jobs that did not finished executing(maybe because of exeeded walltime). - +### Resuming job/batch `smart_dispatch.py -q qtest@mp2 resume {batch_id}` + +Jobs that did not terminate properly, for example, it exceeded the walltime, can be resumed using the {batch_id} given to you upon launch. Of course, all this assuming your script is resumable. + +*Note: Jobs are always in a batch, even if it's a batch of one.*