@@ -9,7 +9,7 @@ available plugins allow local and distributed execution of workflows and
9
9
debugging. Each available plugin is described below.
10
10
11
11
Current plugins are available for Linear, Multiprocessing, IPython _ distributed
12
- processing platforms and for direct processing on SGE _, PBS _, Condor _ , and LSF _. We
12
+ processing platforms and for direct processing on SGE _, PBS _, HTCondor _ , and LSF _. We
13
13
anticipate future plugins for the Soma _ workflow.
14
14
15
15
.. note ::
@@ -34,7 +34,7 @@ Optional arguments::
34
34
.. note ::
35
35
36
36
Except for the status_callback, the remaining arguments only apply to the
37
- distributed plugins: MultiProc/IPython(X)/SGE/PBS/Condor /LSF
37
+ distributed plugins: MultiProc/IPython(X)/SGE/PBS/HTCondor/HTCondorDAGMan /LSF
38
38
39
39
For example:
40
40
@@ -148,27 +148,71 @@ Optional arguments::
148
148
template: custom template file to use
149
149
bsub_args: any other command line args to be passed to bsub.
150
150
151
- Condor
152
- ------
151
+ HTCondor
152
+ --------
153
+
154
+ DAGMan
155
+ ~~~~~~
156
+
157
+ With its DAGMan _ component HTCondor _ (previously Condor) allows for submitting
158
+ entire graphs of dependent jobs at once. With the ``CondorDAGMan `` plug-in
159
+ Nipype can utilize this functionality to submit complete workflows directly and
160
+ in a single step. Consequently, and in contrast to other plug-ins, workflow
161
+ execution returns almost instantaneously -- Nipype is only used to generate the
162
+ workflow graph, while job scheduling and dependency resolution are entirely
163
+ managed by HTCondor _.
164
+
165
+ Please note that although DAGMan _ supports specification of data dependencies
166
+ as well as data provisioning on compute nodes this functionality is currently
167
+ not supported by this plug-in. As with all other batch systems supported by
168
+ Nipype, only HTCondor pools with a shared file system can be used to process
169
+ Nipype workflows.
170
+
171
+ Workflow execution with HTCondor DAGMan is done by calling::
172
+
173
+ workflow.run(plugin='CondorDAGMan')
174
+
175
+ Job execution behavior can be tweaked with the following optional plug-in
176
+ arguments::
177
+
178
+ template : submit spec template to use for job submission. The template
179
+ all generated submit specs are appended to this template. This
180
+ can be a str or a filename.
181
+ submit_specs : additional submit specs that are appended to the generated
182
+ submit specs to allow for overriding or extending the defaults.
183
+ This can be a str or a filename.
184
+ dagman_args : arguments to be prepended to the job execution script in the
185
+ dagman call
186
+
187
+ Please see the `HTCondor documentation `_ for details on possible configuration
188
+ options and command line arguments.
189
+
190
+ ``qsub `` emulation
191
+ ~~~~~~~~~~~~~~~~~~
192
+
193
+ .. note ::
194
+
195
+ This plug-in is deprecated and users should migrate to the more robust and
196
+ more versatile ``CondorDAGMan `` plug-in.
153
197
154
- Despite the differences between Condor and SGE-like batch systems the plugin
155
- usage (incl. supported arguments) is almost identical. The Condor plugin relies
156
- on a ``qsub `` emulation script for Condor , called ``condor_qsub `` that can be
198
+ Despite the differences between HTCondor and SGE-like batch systems the plugin
199
+ usage (incl. supported arguments) is almost identical. The HTCondor plugin relies
200
+ on a ``qsub `` emulation script for HTCondor , called ``condor_qsub `` that can be
157
201
obtained from a `Git repository on git.debian.org `_. This script is currently
158
- not shipped with a standard Condor distribution, but is included in the Condor
202
+ not shipped with a standard HTCondor distribution, but is included in the HTCondor
159
203
package from http://neuro.debian.net. It is sufficient to download this script
160
204
and install it in any location on a system that is included in the ``PATH ``
161
205
configuration.
162
206
163
207
.. _Git repository on git.debian.org : http://anonscm.debian.org/gitweb/?p=pkg-exppsy/condor.git;a=blob_plain;f=debian/condor_qsub;hb=HEAD
164
208
165
- Running a workflow in a Condor pool is done by calling::
209
+ Running a workflow in a HTCondor pool is done by calling::
166
210
167
211
workflow.run(plugin='Condor')
168
212
169
213
The plugin supports a limited set of qsub arguments (``qsub_args ``) that cover
170
214
the most common use cases. The ``condor_qsub `` emulation script translates qsub
171
- arguments into the corresponding Condor terminology and handles the actual job
215
+ arguments into the corresponding HTCondor terminology and handles the actual job
172
216
submission. For details on supported options see the manpage of ``condor_qsub ``.
173
217
174
218
Optional arguments::
@@ -182,4 +226,6 @@ Optional arguments::
182
226
.. _Soma : http://brainvisa.info/soma/soma-workflow/
183
227
.. _PBS : http://www.clusterresources.com/products/torque-resource-manager.php
184
228
.. _LSF : http://www.platform.com/Products/platform-lsf
185
- .. _Condor : http://www.cs.wisc.edu/condor/
229
+ .. _HTCondor : http://www.cs.wisc.edu/htcondor/
230
+ .. _DAGMan : http://research.cs.wisc.edu/htcondor/dagman/dagman.html
231
+ .. _HTCondor documentation : http://research.cs.wisc.edu/htcondor/manual
0 commit comments