Parameters: |
- target_tasks – targets task functions which will be run if they are out-of-date
- forcedtorun_tasks – task functions which will be run whether or not they are out-of-date
- multiprocess – The number of concurrent jobs running on different processes.
- multithread – The number of concurrent jobs running as different threads. If > 1, ruffus will use multithreading instead of multiprocessing (and ignore the multiprocess parameter). Using multi threading is particularly useful to manage high performance clusters which otherwise are prone to “processor storms” when large number of cores finish jobs at the same time. (Thanks Andreas Heger)
- logger (logging objects) – Where progress will be logged. Defaults to stderr output.
- verbose – level 0 : nothing
level 1 : Out-of-date Task names
level 2 : All Tasks (including any task function docstrings)
level 3 : Out-of-date Jobs in Out-of-date Tasks, no explanation
level 4 : Out-of-date Jobs in Out-of-date Tasks, with explanations and warnings
level 5 : All Jobs in Out-of-date Tasks, (include only list of up-to-date tasks)
level 6 : All jobs in All Tasks whether out of date or not
level 10: logs messages useful only for debugging ruffus pipeline code
- touch_files_only – Create or update input/output files only to simulate running the pipeline. Do not run jobs. If set to CHECKSUM_REGENERATE, will regenerate the checksum history file to reflect the existing i/o files on disk.
- exceptions_terminate_immediately – Exceptions cause immediate termination
rather than waiting for N jobs to finish where N = multiprocess
- log_exceptions – Print exceptions to the logger as soon as they occur.
- checksum_level – Several options for checking up-to-dateness are available: Default is level 1.
level 0 : Use only file timestamps
level 1 : above, plus timestamp of successful job completion
level 2 : above, plus a checksum of the pipeline function body
level 3 : above, plus a checksum of the pipeline function default arguments and the additional arguments passed in by task decorators
- one_second_per_job – To work around poor file timepstamp resolution for some file systems. Defaults to True if checksum_level is 0 forcing Tasks to take a minimum of 1 second to complete.
- runtime_data – Experimental feature for passing data to tasks at run time
- gnu_make_maximal_rebuild_mode – Defaults to re-running all out-of-date tasks. Runs minimal
set to build targets if set to True. Use with caution.
- history_file – The database file which stores checksums and file timestamps for input/output files.
- verbose_abbreviated_path – whether input and output paths are abbreviated.
level 0: The full (expanded, abspath) input or output path
level > 1: The number of subdirectories to include. Abbreviated paths are prefixed with [,,,]/
level < 0: level < 0: Input / Output parameters are truncated to MMM letters where verbose_abbreviated_path ==-MMM. Subdirectories are first removed to see if this allows the paths to fit in the specified limit. Otherwise abbreviated paths are prefixed by <???>
|