Skip to content

Commit

Permalink
docs: format table
Browse files Browse the repository at this point in the history
  • Loading branch information
johanneskoester committed Dec 13, 2022
1 parent e45b9e6 commit 4180a1b
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/executing/cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,25 +91,25 @@ a mapping between Snakemake and SLURM needs to be performed.

We can use the following specifications, unique per rule:

+-----------------+-----------------------+------------------------------------------------------------------+
| SLURM Resource | Snakemake resource | Background Information |
+=================+=======================+==================================================================+
| ``-p``/``--partition`` | ``slurm_partition`` | the partition a rule/job is to use |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``-t``/``--time`` | ``runtime`` | the walltime per job in minutes |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``-C``/`--constraint`| ``constraint`` | may hold features on some clusters |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``--mem`` | ``mem_mb`` | memory in MB a cluster node must provide |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``--mem-per-cpu`` | ``mem_mb_per_cpu`` | memory per reserved CPU |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``-n``/``--ntasks`` | ``tasks`` | number of concurrent tasks / ranks |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``-c``/``--cpus-per-task`` | ``cpus_per_task``| number of cpus per task (in case of SMP, rather use ``threads``) |
+-----------------+-----------------------+------------------------------------------------------------------+
| ``-N``/``--nodes`` | ``nodes`` | number of nodes |
+-----------------+-----------------------+------------------------------------------------------------------+
+----------------------------+---------------------+------------------------------------------------------------------+
| SLURM Resource | Snakemake resource | Background Information |
+============================+=====================+==================================================================+
| ``-p``/``--partition`` | ``slurm_partition`` | the partition a rule/job is to use |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``-t``/``--time`` | ``runtime`` | the walltime per job in minutes |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``-C``/`--constraint` | ``constraint`` | may hold features on some clusters |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``--mem`` | ``mem_mb`` | memory in MB a cluster node must provide |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``--mem-per-cpu`` | ``mem_mb_per_cpu`` | memory per reserved CPU |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``-n``/``--ntasks`` | ``tasks`` | number of concurrent tasks / ranks |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``-c``/``--cpus-per-task`` | ``cpus_per_task`` | number of cpus per task (in case of SMP, rather use ``threads``) |
+----------------------------+---------------------+------------------------------------------------------------------+
| ``-N``/``--nodes`` | ``nodes`` | number of nodes |
+----------------------------+---------------------+------------------------------------------------------------------+

Each of these can be part of a rule, e.g.:

Expand Down

0 comments on commit 4180a1b

Please sign in to comment.