catalog
¶
List the model factories for the builder page.
ListedParam
¶
Bases: TypedDict
One factory argument the builder page can edit.
choices is present when kind is choice. minimum is present
when kind is integer. default is the text that fills the chip.
An empty edges default means the chain preset. disables names the
other fields this one locks once its text leaves that default.
Source code in shadowsim/models/catalog.py
ListedModel
¶
ListedModelTerm
¶
Bases: ListedModel
A Hamiltonian or Lindblad block that can be added beside a model factory.
Source code in shadowsim/models/catalog.py
listed_models
¶
listed_models() -> list[ListedModel]
Return the public model factories in __all__ order.
Classes are omitted. A factory that requires n_qubits is marked so the
page can fill that argument from the Qubits setting. params lists the
other factory arguments the chip can edit, with defaults filled in.
Returns:
-
list[ListedModel]–Models the builder page can offer.
Source code in shadowsim/models/catalog.py
listed_model_terms
¶
listed_model_terms() -> list[ListedModelTerm]
Return Hamiltonian and Lindblad blocks in a fixed order.
Each record names the class the block constructs. adds tells the page to
keep the chosen model factory when the block is placed.
Returns:
-
list[ListedModelTerm]–Operator blocks the builder page can add to a model.