catalog
¶
List the concrete circuit backends for the builder page.
ListedField
¶
Bases: TypedDict
One constructor setting the builder page can edit.
Source code in shadowsim/backends/catalog.py
ListedBackend
¶
Bases: TypedDict
Display record for one concrete circuit backend.
Source code in shadowsim/backends/catalog.py
listed_backends
¶
listed_backends() -> list[ListedBackend]
Return the concrete circuit backends in export order.
Each exported backend module is imported on its own. A missing extra skips
that module. CircuitBackend is a protocol, so it is omitted. Each
record uses the class name and the first line of its docstring. Required
constructor arguments appear in setup. A shots parameter is written
as {shots} so the page can fill the shot budget. basis_gates, when
its default is None, is a gate list written as {basis_gates}. Its
choices are the class attribute BASIS_GATE_NAMES. Any other parameter
with a default is a numeric field the page can edit, written as {name}.
Returns:
-
list[ListedBackend]–Backends the builder page can offer.
Raises:
-
ImportError–No circuit backend module could be imported. The first failure is re-raised.