diff --git a/README.md b/README.md index 31cf41da33aaee881e9083e7f16bd0b60c217e28..97886183467828f73d8dbf3ae8bb80b437ccf9d0 100644 --- a/README.md +++ b/README.md @@ -17,31 +17,31 @@ Here are the requirements for each script: ## 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. Several options can be used: -- **–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. -- **–core *NB<sub>CORES</sub>***: number of cores required by your job. Defaults to 1. -- **–interative**: launch job in interative mode instead of passive. -- **–gpu**: request GPUs. -- **–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. -- **–anterior *ANTERIOR<sub>ID</sub>***: 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). -- **–name *name***: name of the job. -- **–directory *directory***: directory in which will be stored the logs of the standard output and input. +- `--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. +- `--core` *NB\_CORES*: number of cores required by your job. Defaults to 1. +- `--interative`: launch job in interative mode instead of passive. +- `--gpu`: request GPUs. +- `--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. +- `--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). +- `--name` *name*: name of the job. +- `--directory` *directory*: directory in which will be stored the logs of the standard output and input. ## OARSTATS -The basic usage of `oarstats` is simply 'python oarstats.py'. +The basic usage of `oarstats` is simply `python oarstats.py`. 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. 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. diff --git a/README.org b/README.org index 9e4b0493457803a370f48f63f7b197464d9a3439..f3c88c6466ff82d35fa2a90df44cf6e42b7bccff 100644 --- a/README.org +++ b/README.org @@ -1,4 +1,4 @@ -#+options: toc:nil +#+options: toc:nil _:{} ^:{} This repository groups a set of tools to easily use OAR. @@ -15,27 +15,27 @@ Here are the requirements for each script: ** 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. Several options can be used: -+ *--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. -+ *--core /NB_CORES/*: number of cores required by your job. Defaults to 1. -+ *--interative*: launch job in interative mode instead of passive. -+ *--gpu*: request GPUs. -+ *--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. -+ *--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). -+ *--name /name/*: name of the job. -+ *--directory /directory/*: directory in which will be stored the logs of the standard output and input. ++ =--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. ++ =--core= /NB_CORES/: number of cores required by your job. Defaults to 1. ++ =--interative=: launch job in interative mode instead of passive. ++ =--gpu=: request GPUs. ++ =--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. ++ =--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). ++ =--name= /name/: name of the job. ++ =--directory= /directory/: directory in which will be stored the logs of the standard output and input. ** OARSTATS -The basic usage of ~oarstats~ is simply 'python oarstats.py'. +The basic usage of ~oarstats~ is simply ~python oarstats.py~. 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. 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.