DeBasher API

• Module Configuration
  • load_debasher_module()
  • define_shared_dir()
• Process Implementation
  • read_opt_value_from_func_args()
  • read_flag_from_func_args()
  • write_value_to_desc()
• Serialized Command Line Reading
  • read_opt_value_from_line()
  • read_flag_from_line()
• Option Characterization
  • explain_cmdline_opt()
  • explain_opt()
  • explain_flag()
  • explain_task_shaping_opt()
  • opt_is_cmdline()
  • opt_is_non_mandatory_cmdline()
• Option Definition/Generation
  • define_opt()
  • define_infile_opt()
  • define_indir_opt()
  • define_flag()
  • define_cmdline_opt()
  • define_cmdline_opt_if_given()
  • define_cmdline_infile_opt()
  • define_cmdline_infile_opt_if_given()
  • define_cmdline_indir_opt()
  • define_cmdline_indir_opt_if_given()
  • define_cmdline_flag_if_given()
  • define_procspec_opt()
  • define_fifo_opt()
  • define_fifo_opt_generator()
  • define_opt_from_proc_out()
  • define_opt_from_proc_task_out()
  • get_process_num_tasks()
  • define_value_desc_opt()
  • get_absolute_shdirname()
  • define_opt_from_shared_dir()
  • save_opt_list()
• Program Definition
  • add_debasher_process()
  • add_debasher_seq_process()
  • add_debasher_program()
  • program_type()
• Steps
  • seq_execute()
  • mark_step_done()
  • is_step_done()
  • seq_execute_slurm()
• Resident Node Classes (Python)
  • FBPProcess
    • FBPProcess
    • Hooks
      • FBPProcess.process_data()
      • FBPProcess.capture_node_state()
      • FBPProcess.restore_node_state()
      • FBPProcess.initialize_runtime()
      • FBPProcess.observe()
    • Methods
      • FBPProcess.run()
      • FBPProcess.send_data()
      • FBPProcess.sleep()
      • FBPProcess.inject()
      • FBPProcess.observe_now()
      • FBPProcess.set_notice()
      • FBPProcess.clear_notice()
    • Class attributes
      • FBPProcess.OBSERVE_PORT
      • FBPProcess.OBSERVE_INTERVAL_SECS
      • FBPProcess.HEARTBEAT_INTERVAL_SECONDS
      • FBPProcess.INPUT_LOG_MAX_BYTES
      • FBPProcess.OUT_BACKLOG_MAX_BYTES
      • FBPProcess.OUT_BACKLOG_FAIL_BYTES
      • FBPProcess.GIL_SWITCH_INTERVAL_SECS
      • FBPProcess.NOTICE_MAX_CHARS
  • DirectoryWatcher
    • DirectoryWatcher
    • Methods a module may redefine
      • DirectoryWatcher.request_for()
      • DirectoryWatcher.is_complete()
    • Class attributes
      • DirectoryWatcher.WATCH_DIR
      • DirectoryWatcher.WATCH_DIR_OPTION
      • DirectoryWatcher.PATTERN
      • DirectoryWatcher.STABLE_OBSERVATIONS
      • DirectoryWatcher.REQUESTS_PORT
      • DirectoryWatcher.FILE_OPTION
  • ProgramLauncher
    • ProgramLauncher
    • Class attributes
      • ProgramLauncher.PFILE
      • ProgramLauncher.PFILE_OPTION
      • ProgramLauncher.PROCESS
      • ProgramLauncher.PROCESS_OPTION
      • ProgramLauncher.RUNS_ROOT
      • ProgramLauncher.RUNS_ROOT_OPTION
      • ProgramLauncher.DONE_PORT
      • ProgramLauncher.MAX_CONCURRENT_RUNS
      • ProgramLauncher.BATCH_SCHED
      • ProgramLauncher.STATUS_CHECK_INTERVAL_SECS
  • Supervisor
    • Supervisor
    • Methods a module may redefine
      • Supervisor.on_node_down()
      • Supervisor.on_node_permanently_failed()
    • Class attributes
      • Supervisor.HEARTBEAT_TIMEOUT_SECS
      • Supervisor.HEARTBEAT_CHECK_INTERVAL_SECS
      • Supervisor.STARTUP_TIMEOUT_SECS
      • Supervisor.MAX_RELAUNCH_ATTEMPTS
      • Supervisor.FORCE_STOP_TIMEOUT_SECS