API Documentation

b2luigi summarizes different topics to help you in your everyday task creation and processing. Most important is the b2luigi.process() function, which lets you run arbitrary task graphs on the batch. It is very similar to luigi.build(), but lets you hand in additional parameters for steering the batch execution.

If you are not yet familiar with luigi itself, we recommend you to read its current documentation: luigi Documentation A few highlights are already included in the luigi Features section. The API of the basf2 and gbasf2 integrations is documented in the Contrib Packages chapter.

• Top-Level Function
  • process()
• Utilities
  • requires and inherits
  • Core Utilities
  • Executable
• Super-hero Task Classes
  • Task
  • ExternalTask
  • WrapperTask
  • dispatch()
  • DispatchableTask
• Target
  • FileSystemTarget
  • LocalTarget
• Remote Systems and Targets
  • RemoteFileSystem
  • RemoteTarget
  • XRootDSystem
  • WebDAVSystem
• Parameters
  • wrap_parameter()
• Settings
  • get_setting()
  • set_setting()
  • clear_setting()
  • DeprecatedSettingsWarning
• Temporary File Context Manager
  • on_temporary_files()
  • TemporaryFileContextManager
• Run Modes
  • stderr_console
  • test_task()
  • run_batch_worker()
  • run_as_batch_worker()
  • run_batched()
  • run_local()
  • run_with_tui()
  • run_luigi()
  • run_test_mode()
  • get_task_outputs()
  • render_graph_tree()
  • render_graph_dot()
  • render_graph_summary()
  • show_task_outputs()
  • show_all_outputs()
  • dry_run()
  • REMOVE_OUTPUT_ACTION
  • remove_outputs()
  • legacy_remove_outputs()
  • remove_requirement_outputs()
  • render_task_list()
  • render_task_help()
• Apptainer Process
  • ApptainerProcess
• Worker Scheduler Factory
  • BatchSystems
  • SendJobWorker
  • SendJobWorkerSchedulerFactory
• Batch Process Base Class
  • BatchProcess
• Implemented Batch Processes
  • LSF
  • HTCondor
  • Slurm
• CLI Reference
  • Command reference
  • Parameter generator classes