Skip to content

qutip_simulator

QuTiP-backed quantum simulators.

QutipSimulator

Bases: Simulator

Simulate open or closed quantum dynamics with QuTiP.

Source code in shadowsim/simulators/qutip_simulator.py
class QutipSimulator(Simulator):
    """Simulate open or closed quantum dynamics with QuTiP."""

    title: str = "QuTiP"

    def __init__(
        self,
        hamiltonians: Sequence[Hamiltonian],
        lindblads: Sequence[Operator],
        initial_state: State,
        observables: OperatorSet | Sequence[Operator],
        *,
        num_qubits: int,
        total_time: float,
        time_steps: int,
    ) -> None:
        """Initialize a QuTiP simulator for the given model."""
        super().__init__(
            hamiltonians,
            lindblads,
            initial_state,
            num_qubits=num_qubits,
            total_time=total_time,
            time_steps=time_steps,
            id="qutip_simulator",
        )
        self.observables = observables

    def simulate(self) -> SimulationResult:
        """Evolve the system with QuTiP and store expectation traces."""
        tlist = self.tlist
        H_q = Qobj(combined_hamiltonian_matrix(self.hamiltonians, self.num_qubits))
        psi0 = to_qutip(self.initial_state)
        e_ops = [to_qutip(op) for op in self.observables]
        c_ops = [to_qutip(op) for op in self.lindblads]
        started = perf_counter()
        # Large energy scales can require more internal integration steps.
        # QuTiP stubs may type ``mesolve`` as ``NoReturn``; avoid marking callers unreachable.
        result = cast(
            Any,
            mesolve(
                H_q,
                psi0,
                tlist,
                c_ops=c_ops,
                e_ops=e_ops,
                options={"nsteps": 100000},
            ),
        )
        runtime = perf_counter() - started
        traces = cast(list[np.ndarray], list(result.expect))
        self.results = traces
        return self._make_result(
            traces,
            runtime=runtime,
            seed=None,
            observable_count=len(self.observables),
            lindblad_count=len(self.lindblads),
        )

    def __str__(self) -> str:
        """Return a string representation of the QutipSimulator."""
        return (
            "QutipSimulator("
            f"num_qubits={self.num_qubits}, "
            f"observable_count={len(self.observables)}, "
            f"time_steps={self.time_steps}"
            ")"
        )

    def __repr__(self) -> str:
        """Return a string representation of the QutipSimulator."""
        return (
            "QutipSimulator("
            f"hamiltonians={self.hamiltonians!r}, "
            f"lindblads={self.lindblads!r}, "
            f"initial_state={self.initial_state!r}, "
            f"observables={self.observables!r}, "
            f"num_qubits={self.num_qubits}, "
            f"total_time={self.total_time}, "
            f"time_steps={self.time_steps}"
            ")"
        )

__init__

__init__(
    hamiltonians: Sequence[Hamiltonian],
    lindblads: Sequence[Operator],
    initial_state: State,
    observables: OperatorSet | Sequence[Operator],
    *,
    num_qubits: int,
    total_time: float,
    time_steps: int,
) -> None

Initialize a QuTiP simulator for the given model.

Source code in shadowsim/simulators/qutip_simulator.py
def __init__(
    self,
    hamiltonians: Sequence[Hamiltonian],
    lindblads: Sequence[Operator],
    initial_state: State,
    observables: OperatorSet | Sequence[Operator],
    *,
    num_qubits: int,
    total_time: float,
    time_steps: int,
) -> None:
    """Initialize a QuTiP simulator for the given model."""
    super().__init__(
        hamiltonians,
        lindblads,
        initial_state,
        num_qubits=num_qubits,
        total_time=total_time,
        time_steps=time_steps,
        id="qutip_simulator",
    )
    self.observables = observables

simulate

simulate() -> SimulationResult

Evolve the system with QuTiP and store expectation traces.

Source code in shadowsim/simulators/qutip_simulator.py
def simulate(self) -> SimulationResult:
    """Evolve the system with QuTiP and store expectation traces."""
    tlist = self.tlist
    H_q = Qobj(combined_hamiltonian_matrix(self.hamiltonians, self.num_qubits))
    psi0 = to_qutip(self.initial_state)
    e_ops = [to_qutip(op) for op in self.observables]
    c_ops = [to_qutip(op) for op in self.lindblads]
    started = perf_counter()
    # Large energy scales can require more internal integration steps.
    # QuTiP stubs may type ``mesolve`` as ``NoReturn``; avoid marking callers unreachable.
    result = cast(
        Any,
        mesolve(
            H_q,
            psi0,
            tlist,
            c_ops=c_ops,
            e_ops=e_ops,
            options={"nsteps": 100000},
        ),
    )
    runtime = perf_counter() - started
    traces = cast(list[np.ndarray], list(result.expect))
    self.results = traces
    return self._make_result(
        traces,
        runtime=runtime,
        seed=None,
        observable_count=len(self.observables),
        lindblad_count=len(self.lindblads),
    )

__str__

__str__() -> str

Return a string representation of the QutipSimulator.

Source code in shadowsim/simulators/qutip_simulator.py
def __str__(self) -> str:
    """Return a string representation of the QutipSimulator."""
    return (
        "QutipSimulator("
        f"num_qubits={self.num_qubits}, "
        f"observable_count={len(self.observables)}, "
        f"time_steps={self.time_steps}"
        ")"
    )

__repr__

__repr__() -> str

Return a string representation of the QutipSimulator.

Source code in shadowsim/simulators/qutip_simulator.py
def __repr__(self) -> str:
    """Return a string representation of the QutipSimulator."""
    return (
        "QutipSimulator("
        f"hamiltonians={self.hamiltonians!r}, "
        f"lindblads={self.lindblads!r}, "
        f"initial_state={self.initial_state!r}, "
        f"observables={self.observables!r}, "
        f"num_qubits={self.num_qubits}, "
        f"total_time={self.total_time}, "
        f"time_steps={self.time_steps}"
        ")"
    )