interop
¶
Interop helpers for optional external libraries.
from_qutip
¶
from_qutip(
qobj: Qobj,
*,
kind: Kind | None = None,
num_qubits: int | None = None,
local_dim: int | None = None,
) -> State | DensityOperator | Hamiltonian | Operator
Convert a QuTiP Qobj to a ShadowSim core type.
When kind is omitted, inference is:
- ket or bra →
State - square Hermitian PSD unit-trace oper →
DensityOperator - other square Hermitian oper →
Hamiltonian - other square oper →
Operator
Parameters:
-
qobj(Qobj) –QuTiP quantum object to convert.
-
kind(Kind | None, default:None) –Optional override:
"state","hamiltonian","operator", or"density". -
num_qubits(int | None, default:None) –Override inferred site count when building a
State. -
local_dim(int | None, default:None) –Override inferred local dimension when building a
State.
Returns:
-
State | DensityOperator | Hamiltonian | Operator–The corresponding ShadowSim object.
Raises:
-
TypeError–If
qobjis not aQobj, orkindis invalid. -
ValueError–If the object type cannot be converted, or state dims are ambiguous / inconsistent.
Source code in shadowsim/interop/qutip.py
to_qutip
¶
to_qutip(
obj: State | Operator | Hamiltonian | DensityOperator,
) -> Qobj
Convert a ShadowSim core type to a QuTiP Qobj.
Parameters:
-
obj(State | Operator | Hamiltonian | DensityOperator) –ShadowSim object to convert.
Returns:
-
Qobj–A ket
QobjforState(flat dims[[dim], [1]]), or an oper -
Qobj–Qobjfor operators (includingHamiltonianandDensityOperator). -
Qobj–Flat state dims match dense Hamiltonians passed to QuTiP solvers.
Raises:
-
TypeError–If
objis not a supported ShadowSim type.
Source code in shadowsim/interop/qutip.py
__getattr__
¶
Import a QuTiP interop helper the first time it is accessed.