Skip to content

Commit 9d3a322

Browse files
committed
Update README.md
Mini cleanup
1 parent 704bcf2 commit 9d3a322

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![Coverage Status](https://coveralls.io/repos/SMART-Lab/smartdispatch/badge.png)](https://coveralls.io/r/SMART-Lab/smartdispatch)
33
[![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)
44
# Smart Dispatch
5-
A batch job launcher for the Mammouth supercomputer.
5+
A batch launcher for supercomputers using qsub (Torque).
66

77
## Installing
88
`pip install git+https://github.com/SMART-Lab/smartdispatch`
@@ -12,30 +12,27 @@ See `smart_dispatch.py --help`
1212

1313
## Examples
1414
###Basic
15-
To launch a job composed of four variations of a simple command:
15+
A batch composed of four variations of a simple command.
1616

1717
`smart_dispatch.py -q qtest@mp2 launch python my_script.py "1 2" 80 "tanh sigmoid" 0.1`
1818

19-
Will generate 4 different commands, launch them on the queue qtest@mp2 and save output/error logs in a folder `./SMART_DISPATCH_LOGS/{job_id}/logs/`.
20-
19+
This will generate 4 different commands and launch them on the queue qtest@mp2:
2120
```
2221
python my_script.py 1 80 sigmoid 0.1
2322
python my_script.py 1 80 tanh 0.1
2423
python my_script.py 2 80 sigmoid 0.1
2524
python my_script.py 2 80 tanh 0.1
2625
```
26+
The output/error logs in are saved in the folder `./SMART_DISPATCH_LOGS/{job_id}/logs/`.
2727

28-
###Using a pool of workers
29-
Building upon previous example, one could prefer using a pool of workers to achieve the execution of the commands:
3028

29+
###Using a pool of workers
3130
`smart_dispatch.py -q qtest@mp2 -p 2 launch python my_script.py "1 2" 80 "tanh sigmoid" 0.1`
3231

33-
Will still generate four different commands but, instead of launching them, two worker commands will be launched on qtest@mp2 to execute all generated commands.
32+
This will behave exactly the same way as the basic example above but the number of commands launched on the supercomputer will be 2 instead of 4 and each job will be in charge of running 2 commands each.
3433

3534

3635
###Resuming a job (if launched using pool of workers)
37-
Given the `job_id` (i.e. folder's name in `SMART_DISPATCH_LOGS/{job_id}/`) one can resume a job that was launched using the pool of workers option:
38-
39-
`smart_dispatch.py -q qtest@mp2 -p 4 resume job_id`
36+
Given the `job_id` (i.e. folder's name in `SMART_DISPATCH_LOGS/{job_id}/`) one can relaunch jobs that did not finished executing(maybe because of exeeded walltime).
4037

41-
Will launch four worker commands to resume the execution of generated commands. Note that if a command was not finished, it will be reexecuted thus one has to make sure commands are re-runnable.
38+
`smart_dispatch.py -q qtest@mp2 -p 2 resume job_id`

0 commit comments

Comments
 (0)