4.1.8. Runs#

simbricks.cli.commands.runs.follow(run_id: int)#: Follow individual run as it executes.

simbricks.cli.commands.runs.run_con(run_id: int)#: Print a runs console completely.

simbricks.cli.commands.runs.ls_rf(run_id: ~typing.Annotated[int, <typer.models.ArgumentInfo object at 0x79f24b7d96f0>])#: List all run fragments of a run.

simbricks.cli.commands.runs.get_output_artifact(run_fragment_id: ~typing.Annotated[int, <typer.models.ArgumentInfo object at 0x79f24b7da2c0>], path: ~pathlib.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x79f24b7daaa0>] = PosixPath('.'))#: Retrieve the output artifact that is stored for a run fragment.

simbricks.cli.commands.runs.delete(run_id: int)#: Delete an individual run.

simbricks.cli.commands.runs.submit(path: ~pathlib.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x79f24b7da350>], follow: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x79f24b7dab30>] = False)#: Submit a SimBricks python simulation script to run.

simbricks.cli.commands.runs.create(instantiation_id: int, follow: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x79f24b7daef0>] = False)#: Create a virtual prototype run based on an already submitted configuration.

simbricks.cli.commands.runs.create_event(runner_id: int, run_id: int, run_event_type: ~simbricks.schemas.base.Annotated[~simbricks.schemas.base.RunEventType, <typer.models.ArgumentInfo object at 0x79f24b7dae90>])#: Send a heartbeat event to a runner.

simbricks.cli.commands.runs.delete_event(runner_id: int, run_id: int, event_id: int)#: Delete a runner event.

simbricks.cli.commands.runs.update_event(event_id: int, runner_id: int, run_id: int, run_event_type: ~simbricks.schemas.base.Annotated[~simbricks.schemas.base.RunEventType, <typer.models.ArgumentInfo object at 0x79f24b7dad10>], event_status: ~types.Annotated[~simbricks.schemas.base.ApiEventStatus | None, <typer.models.OptionInfo object at 0x79f24b7dae00>] = None)#: Update a runner event.

simbricks.cli.commands.runs.ls_events(runner_id: int, run_id: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x79f24b7daf50>] = None, id: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x79f24b7db040>] = None, status: ~types.Annotated[~simbricks.schemas.base.ApiEventStatus | None, <typer.models.OptionInfo object at 0x79f24b7db250>] = None, type: ~types.Annotated[~simbricks.schemas.base.RunEventType | None, <typer.models.OptionInfo object at 0x79f24b7db310>] = None, limit: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x79f24b7db400>] = None)#: List runner related events