Skip to content

Commit

Permalink
Add Pbs Pro execution documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pditommaso committed Jul 27, 2019
1 parent 3ba51a1 commit 1d39ab3
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -104,7 +104,7 @@ Currently the following clusters are supported:
+ [LSF](https://www.nextflow.io/docs/latest/executor.html#lsf)
+ [SLURM](https://www.nextflow.io/docs/latest/executor.html#slurm)
+ [PBS/Torque](https://www.nextflow.io/docs/latest/executor.html#pbs-torque)
+ [HTCondor (experimental)](https://www.nextflow.io/docs/latest/executor.html#htcondor)
+ [HTCondor (beta)](https://www.nextflow.io/docs/latest/executor.html#htcondor)
+ [Moab (beta)](https://www.nextflow.io/docs/latest/executor.html#moab)

For example to submit the execution to a SGE cluster create a file named `nextflow.config`, in the directory
Expand Down
33 changes: 28 additions & 5 deletions docs/executor.rst
Expand Up @@ -136,20 +136,20 @@ The amount of resources requested by each job submission is defined by the follo
* :ref:`process-memory`
* :ref:`process-clusterOptions`

.. _nqsii-executor:
.. _pbspro-executor:

NQSII
=====
PBS Pro
=======

The `NQSII` executor allows you to run your pipeline script by using the `NQSII <https://www.rz.uni-kiel.de/en/our-portfolio/hiperf/nec-linux-cluster>`_ resource manager.
The `PBS Pro` executor allows you to run your pipeline script by using the `PBS Pro <https://www.pbspro.org/>`_ resource manager.

Nextflow manages each process as a separate job that is submitted to the cluster by using the ``qsub`` command provided
by the scheduler.

Being so, the pipeline must be launched from a node where the ``qsub`` command is available, that is, in a common usage
scenario, the cluster `login` node.

To enable the NQSII executor simply set the property ``process.executor = 'nqsii'`` in the ``nextflow.config`` file.
To enable the PBS Pro executor simply set the property ``process.executor = 'pbspro'`` in the ``nextflow.config`` file.

The amount of resources requested by each job submission is defined by the following process directives:

Expand Down Expand Up @@ -186,6 +186,29 @@ The amount of resources requested by each job submission is defined by the follo
* :ref:`process-memory`
* :ref:`process-clusterOptions`

.. _nqsii-executor:

NQSII
=====

The `NQSII` executor allows you to run your pipeline script by using the `NQSII <https://www.rz.uni-kiel.de/en/our-portfolio/hiperf/nec-linux-cluster>`_ resource manager.

Nextflow manages each process as a separate job that is submitted to the cluster by using the ``qsub`` command provided
by the scheduler.

Being so, the pipeline must be launched from a node where the ``qsub`` command is available, that is, in a common usage
scenario, the cluster `login` node.

To enable the NQSII executor simply set the property ``process.executor = 'nqsii'`` in the ``nextflow.config`` file.

The amount of resources requested by each job submission is defined by the following process directives:

* :ref:`process-cpus`
* :ref:`process-queue`
* :ref:`process-time`
* :ref:`process-memory`
* :ref:`process-clusterOptions`

.. _condor-executor:

HTCondor
Expand Down
1 change: 1 addition & 0 deletions docs/process.rst
Expand Up @@ -1506,6 +1506,7 @@ Name Executor
``lsf`` The process is executed using the `Platform LSF <http://en.wikipedia.org/wiki/Platform_LSF>`_ job scheduler.
``slurm`` The process is executed using the SLURM job scheduler.
``pbs`` The process is executed using the `PBS/Torque <http://en.wikipedia.org/wiki/Portable_Batch_System>`_ job scheduler.
``pbspro`` The process is executed using the `PBS Pro <https://www.pbsworks.com/>`_ job scheduler.
``moab`` The process is executed using the `Moab <http://www.adaptivecomputing.com/moab-hpc-basic-edition/>`_ job scheduler.
``condor`` The process is executed using the `HTCondor <https://research.cs.wisc.edu/htcondor/>`_ job scheduler.
``nqsii`` The process is executed using the `NQSII <https://www.rz.uni-kiel.de/en/our-portfolio/hiperf/nec-linux-cluster>`_ job scheduler.
Expand Down

0 comments on commit 1d39ab3

Please sign in to comment.