iblrig.tools.call_bonsai_async
- async iblrig.tools.call_bonsai_async(workflow_file, parameters=None, start=True, debug=False, bootstrap=True, editor=True)[source]
Asynchronously execute a Bonsai workflow within a subprocess call.
- Parameters:
workflow_file (
str | Path
) – Path to the Bonsai workflow file.parameters (
dict[str
,str]
, optional) – Parameters to be passed to Bonsai workflow.start (
bool
, optional) – Start execution of the workflow within Bonsai (default is True).debug (
bool
, optional) – Enable debugging mode if True (default is False). Only applies if editor is True.bootstrap (
bool
, optional) – Enable Bonsai bootstrapping if True (default is True).editor (
bool
, optional) – Enable Bonsai editor if True (default is True).
- Returns:
Pointer to the Bonsai subprocess if wait is False, otherwise subprocess.CompletedProcess.
- Return type:
- Raises:
FileNotFoundError – If the Bonsai executable does not exist. If the specified workflow file does not exist.
- Parameters: