OCDocker.Workbench.Launch module

Non-executing launch-plan helpers for prepared Workbench run bundles.

OCDocker.Workbench.Launch.build_launch_script(plan)[source]

Build shell script content for a Workbench launch plan.

Parameters:

plan (RunLaunchPlan) – Launch-plan payload.

Returns:

Shell script content.

Return type:

str

OCDocker.Workbench.Launch.build_run_launch_plan(target, *, log_dir='logs', script_path=None)[source]

Build a non-executing launch plan from a prepared Workbench bundle.

Parameters:

  • target (str or pathlib.Path) – Run manifest file or prepared bundle directory.

  • log_dir (str or pathlib.Path) – Log directory. Relative values are resolved from the run workspace.

  • script_path (str or pathlib.Path or None) – Optional shell-script path. Relative values are resolved from the run workspace.

Returns:

Non-executing launch-plan payload for GUI or CLI consumers.

Return type:

RunLaunchPlan

OCDocker.Workbench.Launch.write_launch_script(plan, *, overwrite=False)[source]

Write a launch script for a plan without executing it.

Parameters:

  • plan (RunLaunchPlan) – Launch-plan payload with script_path set.

  • overwrite (bool) – If True, overwrite an existing script file.

Returns:

Plan updated with script_written set to True.

Return type:

RunLaunchPlan