4.2. Client#
4.2.1. Opus#
- simbricks.client.opus.base.user_display_name(user: User | None | Unset) str#
Readable name for the user the backend attached to an API object.
Empty when the backend sent none, which is the case for objects created before user references existed.
- async simbricks.client.opus.base.still_running(run_id: str) bool#
- async simbricks.client.opus.base.get_runs_page(sbc: SimBricksClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[Run], str | None]#
Fetch a page of runs. See
_unwrap_page()for the cursor semantics.
- async simbricks.client.opus.base.get_systems_page(sbc: SimBricksClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[System], str | None]#
Fetch a page of systems. See
_unwrap_page()for the cursor semantics.
- async simbricks.client.opus.base.get_simulations_page(sbc: SimBricksClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[Simulation], str | None]#
Fetch a page of simulations. See
_unwrap_page()for the cursor semantics.
- async simbricks.client.opus.base.get_instantiations_page(sbc: SimBricksClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[Instantiation], str | None]#
Fetch a page of instantiations. See
_unwrap_page()for the cursor semantics.
- async simbricks.client.opus.base.get_runners_page(rc: RunnerClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[Runner], str | None]#
Fetch a page of runners. See
_unwrap_page()for the cursor semantics.
- async simbricks.client.opus.base.get_resource_groups_page(rgc: ResourceGroupClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[ResourceGroup], str | None]#
Fetch a page of resource groups. See
_unwrap_page()for the cursor semantics.
- async simbricks.client.opus.base.get_namespaces_page(nsc: NSClient, cursor_next: str | None = None, limit: int | None = None) tuple[list[Namespace], str | None]#
Fetch a page of child namespaces. See
_unwrap_page()for the cursor semantics.
- class simbricks.client.opus.base.ConsoleLineGenerator(run_id: str, follow: bool, sbc: SimBricksClient)#
- async generate_lines() AsyncGenerator[tuple[str, str], None]#
- class simbricks.client.opus.base.ComponentOutputPrettyPrinter(console: Console)#
- print_line(prefix: str, line: str)#
- async simbricks.client.opus.base.follow_run(run_id: str) None#
- async simbricks.client.opus.base.submit_simulation(system_id: str, simulation: Simulation) str#
- async simbricks.client.opus.base.submit_instantiation(simulation_id: str, instantiation: Instantiation) str#
- async simbricks.client.opus.base.submit_run(instantiation_id: str) str#
- async simbricks.client.opus.base.create_run(instantiation: Instantiation) str#