Skip to content
Snippets Groups Projects
Commit bc0c7431 authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

BF: Wrong argument names to fsl_sub. Fix a few documentation quirks

parent d3dc4bac
No related branches found
No related tags found
No related merge requests found
"""
Easy format to define input/output files in a python pipeline.
"""Easy format to define input/output files in a python pipeline.
.. warning::
File-tree is now an independent Python library, and will eventually be
removed from ``fslpy`` - visit the `file-tree` :ref:`API documentation
<https://open.win.ox.ac.uk/pages/fsl/file-tree/>`_ for more details.
The goal is to separate the definition of the input/output filenames from the actual code
by defining a directory tree (i.e., FileTree) in a separate file from the code.
......
......@@ -632,8 +632,8 @@ def hold(job_ids, hold_filename=None, timeout=10):
submit = {
'jobhold' : _flatten_job_ids(job_ids),
'minutes' : 1,
'job_name' : '.hold'
'jobtime' : 1,
'name' : '.hold'
}
run(f'touch {hold_filename}', submit=submit)
......
......@@ -19,14 +19,12 @@ For example, you can call BET like so::
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::
dictionary with submission settings, which will be passed through to the
``fsl_sub`` command (run ``fsl_sub --help`` for details on all options)::
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.
fnirt('srf', 'ref', 'out', submit={'queue' : 'long.q', 'jobram' : '4'})
Most of these wrapper functions strive to provide an interface which is as
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment