nipoppy.workflows.services.boutiques

Boutiques runner service.

Classes

BoshRunnerCallable

Protocol for the bosh runner callable.

CommandBuilder

Protocol for a function that builds a command ro run.

ErrorBuilder

Protocol for a function that builds an error message based on the exit code.

Module Contents

nipoppy.workflows.services.boutiques.run_bosh_launch(invocation_str, descriptor_str, run_command, bosh_exec_launch_args=None, dry_run=False)

Execute a Boutiques launch command.

Parameters:

  • invocation_str (str) – The Boutiques invocation as a JSON string.

  • descriptor_str (str) – The Boutiques descriptor as a JSON string.

  • run_command (CommandRunner, optional) – A function to execute the command. Should act like runner.run_command.

  • bosh_exec_launch_args (list of str, optional) – Additional arguments for bosh exec launch.

  • dry_run (bool, optional) – If True, build and log the command but skip actual execution.

Returns:

The return code.

Return type:

int

nipoppy.workflows.services.boutiques.run_bosh_simulate(invocation_str, descriptor_str, run_command, bosh_exec_launch_args=None, dry_run=False)

Execute a Boutiques simulate command.

Parameters:

  • invocation_str (str) – The Boutiques invocation as a JSON string.

  • descriptor_str (str) – The Boutiques descriptor as a JSON string.

  • run_command (CommandRunner, optional) – A function to execute the command. Should act like runner.run_command.

  • bosh_exec_launch_args (list of str, optional) – Additional arguments for bosh exec launch.

  • dry_run (bool, optional) – If True, build and log the command but skip actual execution.

Returns:

The return code.

Return type:

int

nipoppy.workflows.services.boutiques.logger