Commit 75a2eea6 authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

note in wrapper docs about submit argument

parent 0fbe84e7
Pipeline #1870 passed with stages
in 15 minutes and 14 seconds
......@@ -13,6 +13,18 @@ For example, you can call BET like so::
from fsl.wrappers import bet
bet('struct', 'struct_brain')
If you would like a command to be submitted as a cluster job, all wrappers
accept a ``submit`` keyword argument, which may be given a value of ``True``
indicating that the job should be submitted with default settings, or a
dictionary with submission settings::
from fsl.wrappers import fnirt
fnirt('srf', 'ref', 'out', submit=True)
fnirt('srf', 'ref', 'out', submit={'queue' : 'long.q', 'ram' : '4GB'})
See the :mod:`.fslsub` module for more details.
Most of these wrapper functions strive to provide an interface which is as
close as possible to the underlying command-line tool. Most functions use
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment