qilisdk 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

qilisdk/speqtrum/speqtrum_models.py

@@ -14,9 +14,20 @@
 # ruff: noqa: ANN001, ANN202, PLR6301
 from email.utils import parsedate_to_datetime
 from enum import Enum
+from typing import Any, Callable, Generic, TypeVar, cast, overload
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, field_serializer, field_validator
 
+from qilisdk.experiments import (
+    RabiExperiment,
+    RabiExperimentResult,
+    T1Experiment,
+    T1ExperimentResult,
+    T2Experiment,
+    T2ExperimentResult,
+    TwoTonesExperiment,
+    TwoTonesExperimentResult,
+)
 from qilisdk.functionals import (
     Sampling,
     SamplingResult,
@@ -25,7 +36,7 @@ from qilisdk.functionals import (
     VariationalProgram,
     VariationalProgramResult,
 )
-from qilisdk.speqtrum.experiments import RabiExperiment, RabiExperimentResult, T1Experiment, T1ExperimentResult
+from qilisdk.functionals.functional_result import FunctionalResult
 from qilisdk.utils.serialization import deserialize, serialize
 
 
@@ -50,7 +61,7 @@ class Token(SpeQtrumModel):
 
     access_token: str = Field(alias="accessToken")
     expires_in: int = Field(alias="expiresIn")
-    issued_at: str = Field(alias="issuedAt")
+    issued_at: int = Field(alias="issuedAt")
     refresh_token: str = Field(alias="refreshToken")
     token_type: str = Field(alias="tokenType")
 
@@ -86,6 +97,8 @@ class ExecuteType(str, Enum):
     VARIATIONAL_PROGRAM = "variational_program"
     RABI_EXPERIMENT = "rabi_experiment"
     T1_EXPERIMENT = "t1_experiment"
+    T2_EXPERIMENT = "t2_experiment"
+    TWO_TONES_EXPERIMENT = "two_tones_experiment"
 
 
 class SamplingPayload(SpeQtrumModel):
@@ -158,6 +171,34 @@ class T1ExperimentPayload(SpeQtrumModel):
         return v
 
 
+class T2ExperimentPayload(SpeQtrumModel):
+    t2_experiment: T2Experiment = Field(...)
+
+    @field_serializer("t2_experiment")
+    def _serialize_t2_experiment(self, t2_experiment: T2Experiment, _info):
+        return serialize(t2_experiment)
+
+    @field_validator("t2_experiment", mode="before")
+    def _load_t2_experiment(cls, v):
+        if isinstance(v, str):
+            return deserialize(v, T2Experiment)
+        return v
+
+
+class TwoTonesExperimentPayload(SpeQtrumModel):
+    two_tones_experiment: TwoTonesExperiment = Field(...)
+
+    @field_serializer("two_tones_experiment")
+    def _serialize_two_tones_experiment(self, two_tones_experiment: TwoTonesExperiment, _info):
+        return serialize(two_tones_experiment)
+
+    @field_validator("two_tones_experiment", mode="before")
+    def _load_two_tones_experiment(cls, v):
+        if isinstance(v, str):
+            return deserialize(v, TwoTonesExperiment)
+        return v
+
+
 class ExecutePayload(SpeQtrumModel):
     type: ExecuteType = Field(...)
     sampling_payload: SamplingPayload | None = None
@@ -165,6 +206,8 @@ class ExecutePayload(SpeQtrumModel):
     variational_program_payload: VariationalProgramPayload | None = None
     rabi_experiment_payload: RabiExperimentPayload | None = None
     t1_experiment_payload: T1ExperimentPayload | None = None
+    t2_experiment_payload: T2ExperimentPayload | None = None
+    two_tones_experiment_payload: TwoTonesExperimentPayload | None = None
 
 
 class ExecuteResult(SpeQtrumModel):
@@ -174,6 +217,8 @@ class ExecuteResult(SpeQtrumModel):
     variational_program_result: VariationalProgramResult | None = None
     rabi_experiment_result: RabiExperimentResult | None = None
     t1_experiment_result: T1ExperimentResult | None = None
+    t2_experiment_result: T2ExperimentResult | None = None
+    two_tones_experiment_result: TwoTonesExperimentResult | None = None
 
     @field_serializer("sampling_result")
     def _serialize_sampling_result(self, sampling_result: SamplingResult, _info):
@@ -225,6 +270,188 @@ class ExecuteResult(SpeQtrumModel):
             return deserialize(v, T1ExperimentResult)
         return v
 
+    @field_serializer("t2_experiment_result")
+    def _serialize_t2_experiment_resultt(self, t2_experiment_result: T2ExperimentResult, _info):
+        return serialize(t2_experiment_result) if t2_experiment_result is not None else None
+
+    @field_validator("t2_experiment_result", mode="before")
+    def _load_t2_experiment_result(cls, v):
+        if isinstance(v, str) and v.startswith("!"):
+            return deserialize(v, T2ExperimentResult)
+        return v
+
+    @field_serializer("two_tones_experiment_result")
+    def _serialize_two_tones_experiment_result(self, two_tones_experiment_result: TwoTonesExperimentResult, _info):
+        return serialize(two_tones_experiment_result) if two_tones_experiment_result is not None else None
+
+    @field_validator("two_tones_experiment_result", mode="before")
+    def _load_two_tones_experiment_result(cls, v):
+        if isinstance(v, str) and v.startswith("!"):
+            return deserialize(v, TwoTonesExperimentResult)
+        return v
+
+
+TFunctionalResult_co = TypeVar("TFunctionalResult_co", bound=FunctionalResult, covariant=True)
+TVariationalInnerResult = TypeVar("TVariationalInnerResult", bound=FunctionalResult)
+
+
+ResultExtractor = Callable[[ExecuteResult], TFunctionalResult_co]
+
+
+# these helpers live outside the models so they can be referenced by default values
+def _require_sampling_result(result: ExecuteResult) -> SamplingResult:
+    if result.sampling_result is None:
+        raise RuntimeError("SpeQtrum did not return a sampling_result for a sampling execution.")
+    return result.sampling_result
+
+
+def _require_time_evolution_result(result: ExecuteResult) -> TimeEvolutionResult:
+    if result.time_evolution_result is None:
+        raise RuntimeError("SpeQtrum did not return a time_evolution_result for a time evolution execution.")
+    return result.time_evolution_result
+
+
+def _require_variational_program_result(result: ExecuteResult) -> VariationalProgramResult:
+    if result.variational_program_result is None:
+        raise RuntimeError("SpeQtrum did not return a variational_program_result for a variational program execution.")
+    return result.variational_program_result
+
+
+def _require_rabi_experiment_result(result: ExecuteResult) -> RabiExperimentResult:
+    if result.rabi_experiment_result is None:
+        raise RuntimeError("SpeQtrum did not return a rabi_experiment_result for a Rabi experiment execution.")
+    return result.rabi_experiment_result
+
+
+def _require_t1_experiment_result(result: ExecuteResult) -> T1ExperimentResult:
+    if result.t1_experiment_result is None:
+        raise RuntimeError("SpeQtrum did not return a t1_experiment_result for a T1 experiment execution.")
+    return result.t1_experiment_result
+
+
+def _require_t2_experiment_result(result: ExecuteResult) -> T2ExperimentResult:
+    if result.t2_experiment_result is None:
+        raise RuntimeError("SpeQtrum did not return a t2_experiment_result for a T2 experiment execution.")
+    return result.t2_experiment_result
+
+
+def _require_two_tones_experiment_result(result: ExecuteResult) -> TwoTonesExperimentResult:
+    if result.two_tones_experiment_result is None:
+        raise RuntimeError(
+            "SpeQtrum did not return a two_tones_experiment_result for a Two-Tones experiment execution."
+        )
+    return result.two_tones_experiment_result
+
+
+def _require_variational_program_result_typed(
+    inner_result_type: type[TVariationalInnerResult],
+) -> ResultExtractor[VariationalProgramResult[TVariationalInnerResult]]:
+    def _extractor(result: ExecuteResult) -> VariationalProgramResult[TVariationalInnerResult]:
+        variational_result = _require_variational_program_result(result)
+        optimal_results = variational_result.optimal_execution_results
+        if not isinstance(optimal_results, inner_result_type):
+            raise RuntimeError(
+                "SpeQtrum returned a variational program result whose optimal execution result "
+                f"({type(optimal_results).__qualname__}) does not match the expected "
+                f"{inner_result_type.__qualname__}."
+            )
+        return cast("VariationalProgramResult[TVariationalInnerResult]", variational_result)
+
+    return _extractor
+
+
+class JobHandle(SpeQtrumModel, Generic[TFunctionalResult_co]):
+    """Strongly typed reference to a submitted SpeQtrum job."""
+
+    id: int
+    execute_type: ExecuteType
+    extractor: ResultExtractor[TFunctionalResult_co] = Field(repr=False, exclude=True)
+
+    @classmethod
+    def sampling(cls, job_id: int) -> "JobHandle[SamplingResult]":
+        return cls(id=job_id, execute_type=ExecuteType.SAMPLING, extractor=_require_sampling_result)  # type: ignore[return-value, arg-type]
+
+    @classmethod
+    def time_evolution(cls, job_id: int) -> "JobHandle[TimeEvolutionResult]":
+        return cls(id=job_id, execute_type=ExecuteType.TIME_EVOLUTION, extractor=_require_time_evolution_result)  # type: ignore[return-value, arg-type]
+
+    @overload
+    @classmethod
+    def variational_program(cls, job_id: int) -> "JobHandle[VariationalProgramResult]": ...
+
+    @overload
+    @classmethod
+    def variational_program(
+        cls, job_id: int, *, result_type: type[TVariationalInnerResult]
+    ) -> "JobHandle[VariationalProgramResult[TVariationalInnerResult]]": ...
+
+    @classmethod
+    def variational_program(
+        cls, job_id: int, *, result_type: type[TVariationalInnerResult] | None = None
+    ) -> "JobHandle[Any]":
+        """Create a variational-program handle for an existing job identifier.
+
+        Args:
+            job_id: Numeric identifier returned by the SpeQtrum service.
+            result_type: Optional functional result type expected within the
+                variational program payload. When provided the returned handle
+                enforces that the optimiser output matches this type.
+
+        Returns:
+            JobHandle: A handle whose ``get_results`` invocation yields a
+            ``VariationalProgramResult`` preserving the requested inner result
+            type when supplied.
+        """
+        if result_type is None:
+            handle = cls(
+                id=job_id,
+                execute_type=ExecuteType.VARIATIONAL_PROGRAM,
+                extractor=_require_variational_program_result,  # type: ignore[arg-type]
+            )
+            return cast("JobHandle[VariationalProgramResult]", handle)
+
+        extractor = _require_variational_program_result_typed(result_type)
+        handle = cls(id=job_id, execute_type=ExecuteType.VARIATIONAL_PROGRAM, extractor=extractor)  # type: ignore[arg-type]
+        return cast("JobHandle[VariationalProgramResult[TVariationalInnerResult]]", handle)
+
+    @classmethod
+    def rabi_experiment(cls, job_id: int) -> "JobHandle[RabiExperimentResult]":
+        return cls(id=job_id, execute_type=ExecuteType.RABI_EXPERIMENT, extractor=_require_rabi_experiment_result)  # type: ignore[return-value, arg-type]
+
+    @classmethod
+    def t1_experiment(cls, job_id: int) -> "JobHandle[T1ExperimentResult]":
+        return cls(id=job_id, execute_type=ExecuteType.T1_EXPERIMENT, extractor=_require_t1_experiment_result)  # type: ignore[return-value, arg-type]
+
+    @classmethod
+    def t2_experiment(cls, job_id: int) -> "JobHandle[T2ExperimentResult]":
+        return cls(id=job_id, execute_type=ExecuteType.T2_EXPERIMENT, extractor=_require_t2_experiment_result)  # type: ignore[return-value, arg-type]
+
+    @classmethod
+    def two_tones_experiment(cls, job_id: int) -> "JobHandle[TwoTonesExperimentResult]":
+        return cls(
+            id=job_id,
+            execute_type=ExecuteType.TWO_TONES_EXPERIMENT,
+            extractor=_require_two_tones_experiment_result,  # type: ignore[return-value, arg-type]
+        )
+
+    def bind(self, detail: "JobDetail") -> "TypedJobDetail[TFunctionalResult_co]":
+        """Attach this handle's typing information to a concrete job detail.
+
+        Args:
+            detail: Un-typed job detail payload returned by the SpeQtrum API.
+
+        Returns:
+            TypedJobDetail: Wrapper exposing ``get_results`` with the typing
+            captured when the handle was created.
+        """
+        return TypedJobDetail.model_validate(
+            {
+                **detail.model_dump(),
+                "expected_type": self.execute_type,
+                "extractor": self.extractor,
+            }
+        )
+
 
 class JobStatus(str, Enum):
     "Job has not been submitted to the Lab api"
@@ -298,3 +525,32 @@ class JobDetail(JobInfo):
     logs: str | None = None
     error: str | None = None
     error_logs: str | None = None
+
+
+class TypedJobDetail(JobDetail, Generic[TFunctionalResult_co]):
+    """`JobDetail` subclass that exposes a strongly typed `get_results` method."""
+
+    expected_type: ExecuteType = Field(repr=False)
+    extractor: ResultExtractor[TFunctionalResult_co] = Field(repr=False, exclude=True)
+
+    def get_results(self) -> TFunctionalResult_co:
+        """Return the strongly typed execution result.
+
+        Returns:
+            ResultT_co: Result payload associated with the completed job,
+            respecting the type information carried by the originating
+            ``JobHandle``.
+
+        Raises:
+            RuntimeError: If SpeQtrum has not populated the result payload or
+                the execute type disagrees with the handle.
+        """
+        if self.result is None:
+            raise RuntimeError("The job completed without a result payload; inspect `error` or `logs` for details.")
+
+        if self.result.type != self.expected_type:
+            raise RuntimeError(
+                f"Expected a result of type '{self.expected_type.value}' but received '{self.result.type.value}'."
+            )
+
+        return self.extractor(self.result)

qilisdk/utils/openfermion/__init__.py

@@ -0,0 +1,38 @@
+# Copyright 2025 Qilimanjaro Quantum Tech
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import sys
+
+from qilisdk._optionals import ImportedFeature, OptionalFeature, Symbol, import_optional_dependencies
+
+__all__ = []
+
+OPTIONAL_FEATURES: list[OptionalFeature] = [
+    OptionalFeature(
+        name="openfermion",
+        dependencies=["openfermion"],
+        symbols=[
+            Symbol(path="qilisdk.utils.openfermion.openfermion", name="openfermion_to_qilisdk"),
+            Symbol(path="qilisdk.utils.openfermion.openfermion", name="qilisdk_to_openfermion"),
+        ],
+    ),
+]
+
+current_module = sys.modules[__name__]
+
+# Dynamically import (or stub) each feature's symbols and attach them
+for feature in OPTIONAL_FEATURES:
+    imported_feature: ImportedFeature = import_optional_dependencies(feature)
+    for symbol_name, symbol_obj in imported_feature.symbols.items():
+        setattr(current_module, symbol_name, symbol_obj)
+        __all__ += [symbol_name]  # noqa: PLE0604

qilisdk/{common/algorithm.py → utils/openfermion/__init__.pyi}

@@ -11,8 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from abc import ABC
 
+from .openfermion import openfermion_to_qilisdk, qilisdk_to_openfermion
 
-class Algorithm(ABC):
-    """Abstract base class for SDK algorithms."""
+__all__ = ["openfermion_to_qilisdk", "qilisdk_to_openfermion"]

qilisdk/utils/openfermion/openfermion.py

@@ -0,0 +1,45 @@
+# Copyright 2025 Qilimanjaro Quantum Tech
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from openfermion import QubitOperator
+
+from qilisdk.analog import Hamiltonian, PauliI, PauliX, PauliY, PauliZ
+
+
+def openfermion_to_qilisdk(qubit_operator: QubitOperator) -> Hamiltonian:
+    pauli_map = {"X": PauliX, "Y": PauliY, "Z": PauliZ}
+
+    return Hamiltonian(
+        {
+            (tuple((pauli_map[op](q)) for q, op in term) if len(term) > 0 else (PauliI(0),)): coeff
+            for term, coeff in qubit_operator.terms.items()
+        }
+    )
+
+
+def qilisdk_to_openfermion(hamiltonian: Hamiltonian) -> QubitOperator:
+    of_ham = QubitOperator()
+
+    for coeff, terms in hamiltonian:
+        of_term = ""
+        for t in terms:
+            if isinstance(t, PauliI):
+                continue
+
+            of_term += str(t).replace("(", "").replace(")", "") + " "
+        of_term = of_term.rstrip()
+
+        of_ham += QubitOperator(of_term, coeff)
+
+    return of_ham

qilisdk/utils/visualization/schedule_renderers.py

@@ -18,10 +18,11 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 import matplotlib.pyplot as plt
+import numpy as np
 
 if TYPE_CHECKING:
     from qilisdk.analog.schedule import Schedule
-    from qilisdk.common.variables import Number
+    from qilisdk.core.variables import Number
 
 from qilisdk.utils.visualization.style import ScheduleStyle
 
@@ -29,7 +30,13 @@ from qilisdk.utils.visualization.style import ScheduleStyle
 class MatplotlibScheduleRenderer:
     """Render a Schedule using matplotlib, with theme support."""
 
-    def __init__(self, schedule: Schedule, ax: plt.Axes | None = None, *, style: ScheduleStyle | None = None) -> None:
+    def __init__(
+        self,
+        schedule: Schedule,
+        ax: plt.Axes | None = None,
+        *,
+        style: ScheduleStyle | None = None,
+    ) -> None:
         self.schedule = schedule
         self.style = style or ScheduleStyle()
         self.ax = ax or self._make_axes(self.style.dpi, self.style)
@@ -57,13 +64,14 @@ class MatplotlibScheduleRenderer:
         T = self.schedule.T
         dt = self.schedule.dt
         hamiltonians = self.schedule.hamiltonians
-        times = [i * dt for i in range(int(T / dt))]
+        times = list(np.linspace(0, T, int(1 / dt), dtype=float))  # [i * dt for i in range(int((T + dt) / dt))]
+        for t in self.schedule.tlist:
+            if t not in times:
+                times.append(t)
+        times = sorted(times)
         for h in hamiltonians:
-            plots[h] = []
-        for _t in range(int(T / dt)):
-            t = _t * dt
-            for h in hamiltonians:
-                plots[h].append(self.schedule.get_coefficient(t, h))
+            coef = self.schedule.coefficients[h]
+            plots[h] = [coef[float(t)] for t in times]
 
         # Generate gradient colors between primary and accent
         def hex_to_rgb(hex_color: str) -> tuple[int, ...]:
@@ -146,6 +154,11 @@ class MatplotlibScheduleRenderer:
 
         self.ax.figure.savefig(filename, bbox_inches="tight")  # type: ignore[union-attr]
 
+    def show(self) -> None:  # noqa: PLR6301
+        """Show the current figure."""
+
+        plt.show()
+
     @staticmethod
     def _make_axes(dpi: int, style: ScheduleStyle) -> plt.Axes:
         """
@@ -157,5 +170,5 @@ class MatplotlibScheduleRenderer:
         Returns:
             A newly created Matplotlib Axes.
         """
-        _, ax = plt.subplots(figsize=style.figsize, dpi=style.dpi, facecolor=style.theme.background)
+        _, ax = plt.subplots(figsize=style.figsize, dpi=dpi or style.dpi, facecolor=style.theme.background)
         return ax