Skip to content

Commit 922404f

Browse files
committed
Update README.md
1 parent 1211f09 commit 922404f

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,35 @@
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 launcher for supercomputers using qsub/msub (Torque).
5+
An easy to use job launcher for supercomputers with PBS compatible job manager.
6+
7+
8+
## Features
9+
- Launch multiple jobs with a single line.
10+
- Automactically generate combinations of arguments. *(see examples)*
11+
- Automatic ressource management. Determine for you the optimal fit for your commands on nodes.
12+
- Resume batch of commands.
13+
- Easily manage logs.
14+
- Advanced mode for complete control.
15+
616

717
## Installing
818
`pip install git+https://github.com/SMART-Lab/smartdispatch`
919

20+
1021
## Usage
1122
See `smart_dispatch.py --help`
23+
Output and error logs in are saved in : `./SMART_DISPATCH_LOGS/{batch_id}/logs/`.
24+
1225

1326
## Examples
14-
###Basic
15-
A batch composed of four variations of a simple command.
27+
###Launch Job
28+
`smart_dispatch.py -q qtest@mp2 launch python my_script.py 2 80 tanh 0.1`
29+
30+
This will launch `python my_script.py 2 80 tanh 0.1` on the queue qtest@mp2.
31+
32+
###Launch Jobs Batch
33+
Automactically generate commands from combinations of arguments.
1634

1735
`smart_dispatch.py -q qtest@mp2 launch python my_script.py [1 2] 80 [tanh sigmoid] 0.1`
1836

@@ -23,16 +41,8 @@ python my_script.py 1 80 tanh 0.1
2341
python my_script.py 2 80 sigmoid 0.1
2442
python my_script.py 2 80 tanh 0.1
2543
```
26-
The output/error logs in are saved in the folder `./SMART_DISPATCH_LOGS/{job_id}/logs/`.
27-
28-
29-
###Using a pool of workers
30-
`smart_dispatch.py -q qtest@mp2 -p 2 launch python my_script.py [1 2] 80 [tanh sigmoid] 0.1`
31-
32-
This will behave exactly the same way as the basic example above but the number of jobs launched on the supercomputer will be 2 instead of 4 and each job will be in charge of running 2 commands each.
33-
3444

35-
###Resuming a job (if launched using pool of workers)
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).
45+
###Resuming Job
46+
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).
3747

38-
`smart_dispatch.py -q qtest@mp2 -p 2 resume job_id`
48+
`smart_dispatch.py -q qtest@mp2 resume {batch_id}`

0 commit comments

Comments
 (0)