diff --git a/fsl/utils/fslsub.py b/fsl/utils/fslsub.py index a06454048f66071c71ec92dc7c918be4b8a3b93e..0350eb006a189bd03a836ac1a4cf2e344f3a5d79 100644 --- a/fsl/utils/fslsub.py +++ b/fsl/utils/fslsub.py @@ -61,8 +61,11 @@ log = logging.getLogger(__name__) @dataclass class SubmitParams(object): - """ - Represents the fsl_sub parameters + """Represents the fsl_sub parameters + + The ``SubmitParams`` class is deprecated - you should use + :mod:`fsl.wrappers.fsl_sub` instead, or use the ``fsl_sub`` Python + library, which is installed as part of FSL. Any command line script can be submitted by the parameters by calling the `SubmitParams` object: @@ -259,6 +262,10 @@ def submit(*command, **kwargs): """ Submits a given command to the cluster + The ``submit`` function is deprecated - you should use + :mod:`fsl.wrappers.fsl_sub` instead, or use the ``fsl_sub`` Python + library, which is available in FSL 6.0.5 and newer. + You can pass the command and arguments as a single string, or as a regular or unpacked sequence. :arg command: string or regular/unpacked sequence of strings with the job command @@ -293,9 +300,14 @@ def submit(*command, **kwargs): return SubmitParams(**kwargs)(*command) +@deprecated.deprecated('3.7.0', '4.0.0', 'Use fsl_sub.report instead') def info(job_ids) -> Dict[str, Optional[Dict[str, str]]]: """Gets information on a given job id + The ``info`` function is deprecated - you should use the + ``fsl_sub.report`` function from the ``fsl_sub`` Python library, which + is available in FSL 6.0.5 and newer. + Uses `qstat -j <job_ids>` :arg job_ids: string with job id or (nested) sequence with jobs