4.1.8. Runs#

simbricks.cli.commands.runs.ls(limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7ff20cfeb590>] = 20, fetch_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7ff20cfeb4d0>] = False)#

List runs.

Pages interactively when there is more than one page and the output is a terminal. Left and right change page, g jumps back to the first page, r reloads the current one and q quits.

simbricks.cli.commands.runs.peek(limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7ff20cfea660>] = 5)#: Show the most recent runs, 5 by default.

simbricks.cli.commands.runs.show(run_id: str)#: Show individual run.

simbricks.cli.commands.runs.kill(run_id: str)#: Kill individual run.

simbricks.cli.commands.runs.sigusr1(run_id: str)#: Send sigusr1 to run.

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

simbricks.cli.commands.runs.rc(run_id: str)#: Print a runs console completely.

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

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

simbricks.cli.commands.runs.rm(run_id: str)#: Delete an individual run.

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

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