Skip to content

Commit

Permalink
Switch README to github markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
jcdubacq committed Nov 28, 2012
1 parent 08ce4f7 commit a6bc1c8
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,50 @@
# Citation

If you use this software, please cite the corresponding publication:

```
@article{Berenger2010,
author = {Berenger, Francois and Coti, Camille and Zhang, Kam Y. J.},
title = {{PAR: A PARallel And Distributed Job Crusher}},
doi = {10.1093/bioinformatics/btq542},
year = {2010},
journal = {Bioinformatics}
}
```

# you need to install rfoo: http://code.google.com/p/rfoo/
# External dependencies

You need to install rfoo: http://code.google.com/p/rfoo/

# Some usage examples:
## Basic examples

# run in parallel commands from test_parallel.input
Run in parallel commands from test_parallel.input
```
cat test_parallel.input | ./parallel.py -i /dev/stdin
```

# same than before but with a progress bar
Same than before but with a progress bar
```
cat test_parallel.input | ./parallel.py -i /dev/stdin -v

# run in parallel commands from test_parallel.input and store output
# in output.log
```
Run in parallel commands from test_parallel.input and store output in output.log
```
./parallel.py -i test_parallel.input -o output.log
```

# same than before but with a user defined output printer
Same than before but with a user defined output printer
```
./parallel.py -i test_parallel.input -o output.log -p post_proc_example
```

## real world usage example
# 1) server side
1. server side
```
./parallel.py -v -i many_commands.sh -o par_many_commands.log -s
# 2) client side, on each machine you want to join the computation
# replace SERVER_NAME by the machine name from where you launched
# parallel.py using -s
```
2. client side, on each machine you want to join the computation replace SERVER_NAME by the machine name from where you launched parallel.py using `-s`
```
./parallel.py -c SERVER_NAME
# 3) be thrilled! ;)
```
3. be thrilled! ;)

0 comments on commit a6bc1c8

Please sign in to comment.