QuantumSystem

class scqubits.core.qubit_base.QuantumSystem(id_str)

Generic quantum system class.

Return type:

QuantumSystemType

truncated_dim

Hilbert space dimension

Type:

int

Methods

QuantumSystem.__init__(id_str)
QuantumSystem.broadcast(event, **kwargs)	Request a broadcast from CENTRAL_DISPATCH reporting event.
QuantumSystem.create()	Use ipywidgets to create a new class instance.
QuantumSystem.default_params()	Return dictionary with default parameter values for initialization of class instance.
QuantumSystem.get_initdata()	Returns dict appropriate for creating/initializing a new Serializable object.
QuantumSystem.get_operator_names()	Returns a list of all operator names for the quantum system.
QuantumSystem.hilbertdim()	Returns dimension of Hilbert space.
QuantumSystem.receive(event, sender, **kwargs)	Receive a message from CENTRAL_DISPATCH and initiate action on it.
QuantumSystem.set_params(**kwargs)	Set new parameters through the provided dictionary.
QuantumSystem.set_params_from_gui(change)	Set new parameters through the provided dictionary.
QuantumSystem.supported_noise_channels()	Returns a list of noise channels this QuantumSystem supports.
QuantumSystem.widget([params])	Use ipywidgets to modify parameters of class instance.

Attributes

id_str
truncated_dim	Descriptor class for properties that are to be monitored for changes.

broadcast(event, **kwargs)

Request a broadcast from CENTRAL_DISPATCH reporting event.

Parameters:

• event (str) – event name from EVENTS

• **kwargs

Return type:

None

classmethod create()

Use ipywidgets to create a new class instance.

Return type:

QuantumSystem

abstractmethod static default_params()

Return dictionary with default parameter values for initialization of class instance.

Return type:

Dict[str, Any]

get_initdata()

Returns dict appropriate for creating/initializing a new Serializable object.

Return type:

Dict[str, Any]

classmethod get_operator_names()

Returns a list of all operator names for the quantum system. Note that this list omits any operators that start with “_”.

Parameters:

subsys – Class instance of quantum system

Return type:

List[str]

Returns:

list of operator names

abstractmethod hilbertdim()

Returns dimension of Hilbert space.

Return type:

int

receive(event, sender, **kwargs)

Receive a message from CENTRAL_DISPATCH and initiate action on it.

Parameters:

• event (str) – event name from EVENTS

• sender (DispatchClient) – original sender reporting the event

• **kwargs

Return type:

None

set_params(**kwargs)

Set new parameters through the provided dictionary.

set_params_from_gui(change)

Set new parameters through the provided dictionary.

supported_noise_channels()

Returns a list of noise channels this QuantumSystem supports.

If none, return an empty list.

Return type:

List

widget(params=None)

Use ipywidgets to modify parameters of class instance.

Parameters:

params (Dict[str, Any] | None)