Skip to content

Commit ff63657

Browse files
authored
Merge pull request #420 from tristan-f-r/docs-parallel
docs: on parallelization and HPC
2 parents f693822 + 1e2abed commit ff63657

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/usage.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,21 @@ specifying a ``config.yaml`` and the number of cores to run SPRAS with:
1010
.. code-block:: bash
1111
1212
snakemake --cores 1 --configfile config.yaml
13+
14+
Parallelizing SPRAS
15+
-------------------
16+
17+
SPRAS works on any specified number of cores, and will, thanks to Snakemake,
18+
automatically know how to best distribute work across various cores to
19+
finish work specified in a configuration as fast as
20+
possible.
21+
22+
To parallelize SPRAS, specify ``--cores`` to be a value higher than ``1``:
23+
24+
.. code-block:: bash
25+
26+
snakemake --cores 4 --configfile config.yaml
27+
28+
SPRAS also supports high-performance computing with it's integration with
29+
`HTCondor <https://htcondor.org/>`_. See :doc:`Running with HTCondor <../htcondor>`
30+
for more information.

0 commit comments

Comments
 (0)