Skip to content
Snippets Groups Projects
Commit f87b4618 authored by Jeremy Auguste's avatar Jeremy Auguste
Browse files

Updated look of README

parent 7388b939
No related branches found
No related tags found
No related merge requests found
...@@ -17,22 +17,22 @@ Here are the requirements for each script: ...@@ -17,22 +17,22 @@ Here are the requirements for each script:
## OARGEN ## OARGEN
The basic usage of `oargen` is simply `python oargen.py -r /command/` where *command* is the job The basic usage of `oargen` is simply `python oargen.py -r command` where *command* is the job
to execute on the cluster. to execute on the cluster.
Several options can be used: Several options can be used:
- `--run`: run the job on the cluster. - --run: run the job on the cluster.
- `--time` *TIME*: reservation walltime of your job. Accepted formats: *h*, *h:m* or *h:m:s*. Defaults to 10 hours. - --time *TIME*: reservation walltime of your job. Accepted formats: *h*, *h:m* or *h:m:s*. Defaults to 10 hours.
- `--core` *NB\_CORES*: number of cores required by your job. Defaults to 1. - --core *NB\_CORES*: number of cores required by your job. Defaults to 1.
- `--interative`: launch job in interative mode instead of passive. - --interative: launch job in interative mode instead of passive.
- `--gpu`: request GPUs. - --gpu: request GPUs.
- `--host` *host1* [ *host2* … *hostn* ]: name of the hosts allowed to be used on the cluster. - --host *host1* [ *host2* ... *hostn* ]: name of the hosts allowed to be used on the cluster.
- `--ignore-host` *host1* [ *host2* … *hostn* ]: name of the hosts forbidden to be used on the cluster. - --ignore-host *host1* [ *host2* ... *hostn* ]: name of the hosts forbidden to be used on the cluster.
- `--anterior` *ANTERIOR\_ID*: job will only be launched once the job with the specified ID is finished. - --anterior *ANTERIOR\_ID*: job will only be launched once the job with the specified ID is finished.
- `--checkpoint` *delay*: enable the checkpoint signal with the given delay (in seconds). - --checkpoint *delay*: enable the checkpoint signal with the given delay (in seconds).
- `--name` *name*: name of the job. - --name *name*: name of the job.
- `--directory` *directory*: directory in which will be stored the logs of the standard output and input. - --directory *directory*: directory in which will be stored the logs of the standard output and input.
## OARSTATS ## OARSTATS
...@@ -43,5 +43,5 @@ each user. It will also take into account the different queues. ...@@ -43,5 +43,5 @@ each user. It will also take into account the different queues.
One option can be used: One option can be used:
- `--show-hosts`: Adds an extra line for each user indicating which hosts are being used. - --show-hosts: Adds an extra line for each user indicating which hosts are being used.
#+options: toc:nil _:{} ^:{} #+options: toc:nil _:{} ^:{} -:nil
This repository groups a set of tools to easily use OAR. This repository groups a set of tools to easily use OAR.
...@@ -15,21 +15,21 @@ Here are the requirements for each script: ...@@ -15,21 +15,21 @@ Here are the requirements for each script:
** OARGEN ** OARGEN
The basic usage of ~oargen~ is simply ~python oargen.py -r /command/~ where /command/ is the job The basic usage of ~oargen~ is simply ~python oargen.py -r command~ where /command/ is the job
to execute on the cluster. to execute on the cluster.
Several options can be used: Several options can be used:
+ =--run=: run the job on the cluster. + --run: run the job on the cluster.
+ =--time= /TIME/: reservation walltime of your job. Accepted formats: /h/, /h:m/ or /h:m:s/. Defaults to 10 hours. + --time /TIME/: reservation walltime of your job. Accepted formats: /h/, /h:m/ or /h:m:s/. Defaults to 10 hours.
+ =--core= /NB_CORES/: number of cores required by your job. Defaults to 1. + --core /NB_CORES/: number of cores required by your job. Defaults to 1.
+ =--interative=: launch job in interative mode instead of passive. + --interative: launch job in interative mode instead of passive.
+ =--gpu=: request GPUs. + --gpu: request GPUs.
+ =--host= /host1/ [ /host2/ ... /hostn/ ]: name of the hosts allowed to be used on the cluster. + --host /host1/ [ /host2/ ... /hostn/ ]: name of the hosts allowed to be used on the cluster.
+ =--ignore-host= /host1/ [ /host2/ ... /hostn/ ]: name of the hosts forbidden to be used on the cluster. + --ignore-host /host1/ [ /host2/ ... /hostn/ ]: name of the hosts forbidden to be used on the cluster.
+ =--anterior= /ANTERIOR_ID/: job will only be launched once the job with the specified ID is finished. + --anterior /ANTERIOR_ID/: job will only be launched once the job with the specified ID is finished.
+ =--checkpoint= /delay/: enable the checkpoint signal with the given delay (in seconds). + --checkpoint /delay/: enable the checkpoint signal with the given delay (in seconds).
+ =--name= /name/: name of the job. + --name /name/: name of the job.
+ =--directory= /directory/: directory in which will be stored the logs of the standard output and input. + --directory /directory/: directory in which will be stored the logs of the standard output and input.
** OARSTATS ** OARSTATS
...@@ -38,4 +38,4 @@ It will print some information about the number of jobs, cores and gpus used by ...@@ -38,4 +38,4 @@ It will print some information about the number of jobs, cores and gpus used by
each user. It will also take into account the different queues. each user. It will also take into account the different queues.
One option can be used: One option can be used:
+ =--show-hosts=: Adds an extra line for each user indicating which hosts are being used. + --show-hosts: Adds an extra line for each user indicating which hosts are being used.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment