sequence 1.0.0.dev1539950__tar.gz → 1.2.0__tar.gz

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sequence
-Version: 1.0.0.dev1539950
+Version: 1.2.0
 Summary: Simulator of QUantum Network Communication (SeQUeNCe) is an open-source tool that allows modeling of quantum networks including photonic network components, control protocols, and applications.
 Keywords: quantum,network,discrete,event,simulator
 Author: Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Alexander Kiefer, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara, Robert Hayek, Ansh Singal, Caitao Zhan
@@ -9,12 +9,6 @@ License-File: LICENSE
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: dash>=3.3.0
-Requires-Dist: dash-bootstrap-components>=2.0.4
-Requires-Dist: dash-core-components>=2.0.0
-Requires-Dist: dash-cytoscape>=1.0.2
-Requires-Dist: dash-html-components>=2.0.0
-Requires-Dist: dash-table>=5.0.0
 Requires-Dist: gmpy2>=2.2.2
 Requires-Dist: graphviz>=0.21
 Requires-Dist: ipywidgets>=8.1.8
@@ -23,8 +17,6 @@ Requires-Dist: matplotlib>=3.10.7
 Requires-Dist: networkx>=3.6.1
 Requires-Dist: numpy>=2.3.5
 Requires-Dist: pandas>=2.3.3
-Requires-Dist: plotly>=6.5.0
-Requires-Dist: pytest>=9.0.2
 Requires-Dist: pyyaml>=6.0.3
 Requires-Dist: qutip>=5.2.2
 Requires-Dist: qutip-qip>=0.4.1
@@ -61,7 +53,8 @@ Description-Content-Type: text/markdown
 [![QuTiP](https://img.shields.io/badge/integration-QuTiP-blue)](https://qutip.org/)
 [![Stim](https://img.shields.io/badge/integration-Stim-blue)](https://github.com/quantumlib/Stim)
 [![Paper](https://img.shields.io/badge/10.1088%2F2058-9565%2Fac22f6?label=DOI)](https://iopscience.iop.org/article/10.1088/2058-9565/ac22f6)
-[![Download-month](https://img.shields.io/pypi/dm/sequence)](https://pypistats.org/packages/sequence)
+[![Downloads](https://static.pepy.tech/badge/sequence/month)](https://pepy.tech/project/sequence)
+
 
 </div>
 
@@ -95,7 +88,7 @@ Editable installations let Python use your local source tree directly, so change
 #### (1) Using pip
 ```
 git clone https://github.com/sequence-toolbox/SeQUeNCe.git
-cd sequence
+cd SeQUeNCe
 make install_editable
 ```
 
@@ -122,7 +115,7 @@ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | ie
 Here we clone the repository and let uv configure the development environment with the target python version.
 ```bash
 git clone https://github.com/sequence-toolbox/SeQUeNCe.git
-cd sequence
+cd SeQUeNCe
 uv sync
 ```
 
@@ -158,14 +151,6 @@ publisher = {IOP Publishing},
 }
 ```
 
-<!-- * X. Wu, A. Kolar, J. Chung, D. Jin, T. Zhong, R. Kettimuthu and M. Suchara. "SeQUeNCe: Simulator of QUantum Network Communication." GitHub repository, https://github.com/sequence-toolbox/SeQUeNCe, 2021. -->
-
-## Running the GUI
-Once SeQUeNCe has been installed as described above, run the `gui.py` script found in the root of the project directory
-```
-python gui.py
-```
-
 ## Usage Examples
 Many examples of SeQUeNCe in action can be found in the [example](/example) folder. The example includes jupyter notebook demos, and code used in published papers.
 

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/README.md

@@ -17,7 +17,8 @@
 [![QuTiP](https://img.shields.io/badge/integration-QuTiP-blue)](https://qutip.org/)
 [![Stim](https://img.shields.io/badge/integration-Stim-blue)](https://github.com/quantumlib/Stim)
 [![Paper](https://img.shields.io/badge/10.1088%2F2058-9565%2Fac22f6?label=DOI)](https://iopscience.iop.org/article/10.1088/2058-9565/ac22f6)
-[![Download-month](https://img.shields.io/pypi/dm/sequence)](https://pypistats.org/packages/sequence)
+[![Downloads](https://static.pepy.tech/badge/sequence/month)](https://pepy.tech/project/sequence)
+
 
 </div>
 
@@ -51,7 +52,7 @@ Editable installations let Python use your local source tree directly, so change
 #### (1) Using pip
 ```
 git clone https://github.com/sequence-toolbox/SeQUeNCe.git
-cd sequence
+cd SeQUeNCe
 make install_editable
 ```
 
@@ -78,7 +79,7 @@ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | ie
 Here we clone the repository and let uv configure the development environment with the target python version.
 ```bash
 git clone https://github.com/sequence-toolbox/SeQUeNCe.git
-cd sequence
+cd SeQUeNCe
 uv sync
 ```
 
@@ -114,14 +115,6 @@ publisher = {IOP Publishing},
 }
 ```
 
-<!-- * X. Wu, A. Kolar, J. Chung, D. Jin, T. Zhong, R. Kettimuthu and M. Suchara. "SeQUeNCe: Simulator of QUantum Network Communication." GitHub repository, https://github.com/sequence-toolbox/SeQUeNCe, 2021. -->
-
-## Running the GUI
-Once SeQUeNCe has been installed as described above, run the `gui.py` script found in the root of the project directory
-```
-python gui.py
-```
-
 ## Usage Examples
 Many examples of SeQUeNCe in action can be found in the [example](/example) folder. The example includes jupyter notebook demos, and code used in published papers.
 

sequence-1.2.0/pyproject.toml

@@ -0,0 +1,157 @@
+[project]
+name = "sequence"
+version = "1.2.0"
+license-files = ["LICENSE"]
+description = "Simulator of QUantum Network Communication (SeQUeNCe) is an open-source tool that allows modeling of quantum networks including photonic network components, control protocols, and applications."
+readme = "README.md"
+requires-python = ">=3.12, <3.15"
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+keywords = [
+    "quantum",
+    "network",
+    "discrete",
+    "event",
+    "simulator",
+]
+dependencies = [
+    "gmpy2>=2.2.2",
+    "graphviz>=0.21",
+    "ipywidgets>=8.1.8",
+    "jupyterlab>=4.5.0",
+    "matplotlib>=3.10.7",
+    "networkx>=3.6.1",
+    "numpy>=2.3.5",
+    "pandas>=2.3.3",
+    "pyyaml>=6.0.3",
+    "qutip>=5.2.2",
+    "qutip-qip>=0.4.1",
+    "scipy>=1.16.3",
+    "seaborn>=0.13.2",
+    "tqdm>=4.67.1",
+    "typer>=0.24.1",
+    "stim>=1.15",
+]
+
+[[project.authors]]
+name = "Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Alexander Kiefer, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara, Robert Hayek, Ansh Singal, Caitao Zhan"
+email = "czhan@anl.gov"
+
+[[project.maintainers]]
+name = "Caitao Zhan"
+email = "czhan@anl.gov"
+
+[[project.maintainers]]
+name = "Robert Hayek"
+email = "rhayek@anl.gov"
+
+[project.scripts]
+generate-topology = "sequence.utils.config_generator_cli:app"
+
+[project.urls]
+Homepage = "https://github.com/sequence-toolbox/SeQUeNCe"
+Documentation = "https://sequence-rtd-tutorial.readthedocs.io/"
+Issues = "https://github.com/sequence-toolbox/SeQUeNCe/issues"
+Changelog = "https://github.com/sequence-toolbox/SeQUeNCe/blob/master/CHANGELOG.md"
+
+[build-system]
+requires = ["uv_build>=0.11.11,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = ""
+module-name = "sequence"
+
+[tool.pytest.ini_options]
+markers = ["unit: Marks tests as unit tests"]
+
+[tool.semantic_release]
+build_command = """
+    python -m pip install "uv>=0.11,<0.12"
+    uv lock --upgrade-package "$PACKAGE_NAME"
+    git add uv.lock
+"""
+assets = ["uv.lock"]
+version_toml = ["pyproject.toml:project.version"]
+commit_message = """
+{version}
+
+Automatically generated by python-semantic-release"""
+commit_parser = "conventional"
+logging_use_named_masks = false
+major_on_zero = true
+allow_zero_version = false
+no_git_verify = false
+tag_format = "v{version}"
+add_partial_tags = false
+
+[tool.semantic_release.branches.main]
+match = "master"
+
+[tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
+exclude_commit_patterns = []
+mode = "update"
+insertion_flag = "<!-- version list -->"
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"
+output_format = "md"
+mask_initial_release = true
+
+[tool.semantic_release.changelog.environment]
+block_start_string = "{%"
+block_end_string = "%}"
+variable_start_string = "{{"
+variable_end_string = "}}"
+comment_start_string = "{#"
+comment_end_string = "#}"
+trim_blocks = true
+lstrip_blocks = true
+newline_sequence = """
+
+"""
+keep_trailing_newline = true
+extensions = []
+autoescape = false
+
+[tool.semantic_release.commit_parser_options]
+minor_tags = ["feat"]
+patch_tags = [
+    "fix",
+    "docs",
+    "test",
+    "ci",
+    "refactor",
+    "perf",
+    "chore",
+    "revert",
+]
+allowed_tags = [
+    "feat",
+    "fix",
+    "perf",
+    "build",
+    "ci",
+    "docs",
+    "style",
+    "refactor",
+    "test",
+]
+other_allowed_tags = ["chore"]
+default_bump_level = 0
+parse_squash_commits = true
+ignore_merge_commits = true
+
+[dependency-groups]
+dev = [
+    "coverage>=7.13.4",
+    "ruff>=0.15.1",
+    "ty>=0.0.16",
+    "scipy-stubs>=1.16.3,<1.19.0",
+    "pytest-cov>=7.1.0",
+    "pytest>=9.0.2",
+]

sequence-1.0.0.dev1539950/pyproject.toml → sequence-1.2.0/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "sequence"
-version = "1.0.0.dev1539950"
+version = "1.2.0"
 authors = [
     { name = "Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Alexander Kiefer, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara, Robert Hayek, Ansh Singal, Caitao Zhan", email = "czhan@anl.gov" }
 ]
@@ -19,12 +19,6 @@ classifiers = [
 ]
 keywords = ["quantum", "network", "discrete", "event", "simulator"]
 dependencies = [
-    "dash>=3.3.0",
-    "dash-bootstrap-components>=2.0.4",
-    "dash-core-components>=2.0.0",
-    "dash-cytoscape>=1.0.2",
-    "dash-html-components>=2.0.0",
-    "dash-table>=5.0.0",
     "gmpy2>=2.2.2",
     "graphviz>=0.21",
     "ipywidgets>=8.1.8",
@@ -33,8 +27,6 @@ dependencies = [
     "networkx>=3.6.1",
     "numpy>=2.3.5",
     "pandas>=2.3.3",
-    "plotly>=6.5.0",
-    "pytest>=9.0.2",
     "pyyaml>=6.0.3",
     "qutip>=5.2.2",
     "qutip-qip>=0.4.1",
@@ -49,7 +41,7 @@ dependencies = [
 generate-topology = "sequence.utils.config_generator_cli:app"
 
 [build-system]
-requires = ["uv_build>=0.11.11,<0.12"]
+requires = ["uv_build>=0.11.11,<0.13"]
 build-backend = "uv_build"
 
 [tool.uv.build-backend]
@@ -66,12 +58,78 @@ dev = [
     "coverage>=7.13.4",
     "ruff>=0.15.1",
     "ty>=0.0.16",
-    "pandas-stubs~=2.3.3",
-    "scipy-stubs~=1.16.3",
+    "scipy-stubs>=1.16.3,<1.19.0",
+    "pytest-cov>=7.1.0",
+    "pytest>=9.0.2",
 ]
 
 [project.urls]
 Homepage = "https://github.com/sequence-toolbox/SeQUeNCe"
 Documentation = "https://sequence-rtd-tutorial.readthedocs.io/"
 Issues = "https://github.com/sequence-toolbox/SeQUeNCe/issues"
-Changelog = "https://github.com/sequence-toolbox/SeQUeNCe/blob/master/CHANGELOG.md"
+Changelog = "https://github.com/sequence-toolbox/SeQUeNCe/blob/master/CHANGELOG.md"
+
+[tool.semantic_release]
+build_command = """
+    python -m pip install "uv>=0.11,<0.12"
+    uv lock --upgrade-package "$PACKAGE_NAME"
+    git add uv.lock
+"""
+assets = ["uv.lock"]
+version_toml = ["pyproject.toml:project.version"]
+commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
+commit_parser = "conventional"
+logging_use_named_masks = false
+major_on_zero = true
+allow_zero_version = false
+no_git_verify = false
+tag_format = "v{version}"
+add_partial_tags = false
+
+[tool.semantic_release.branches.main]
+match = "master"
+
+[tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
+exclude_commit_patterns = []
+mode = "update"
+insertion_flag = "<!-- version list -->"
+
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"
+output_format = "md"
+mask_initial_release = true
+
+[tool.semantic_release.changelog.environment]
+block_start_string = "{%"
+block_end_string = "%}"
+variable_start_string = "{{"
+variable_end_string = "}}"
+comment_start_string = "{#"
+comment_end_string = "#}"
+trim_blocks = true
+lstrip_blocks = true
+newline_sequence = "\n"
+keep_trailing_newline = true
+extensions = []
+autoescape = false
+
+[tool.semantic_release.commit_parser_options]
+minor_tags = ["feat"]
+patch_tags = [
+    "fix",
+    "docs",
+    "test",
+    "ci",
+    "refactor",
+    "perf",
+    "chore",
+    "revert",
+]
+allowed_tags = ["feat", "fix", "perf", "build", "ci", "docs", "style", "refactor", "test"]
+other_allowed_tags = ["chore"]
+
+default_bump_level = 0
+parse_squash_commits = true
+ignore_merge_commits = true

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/sequence/__init__.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 __all__ = ['app', 'components', 'entanglement_management', 'kernel', 'network_management', 'qkd', 'resource_management',
-           'topology', 'utils', 'message', 'protocol', 'gui', 'read_version_from_pyproject']
+           'topology', 'utils', 'message', 'protocol', 'read_version_from_pyproject']
 
 
 def read_version_from_pyproject() -> str:

sequence-1.2.0/sequence/app/__init__.py

@@ -0,0 +1,5 @@
+__all__ = ["app", "random_request", "teleport_app", "request_app"]
+
+
+def __dir__():
+    return sorted(__all__)

sequence-1.2.0/sequence/app/app.py

@@ -0,0 +1,81 @@
+"""Abstract base class for SeQUeNCe applications.
+
+This module defines the `App` interface that all node-attached applications
+must implement.  The three abstract callback methods, `get_memory`, `get_reservation_result`,
+and `get_other_reservation` are correspond to the calls that `QuantumRouter` already
+makes on whatever application is attached via `set_app`.
+
+Subclasses that track throughput (e.g. `RequestApp`) should override it with a
+meaningful implementation.
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..network_management.reservation import Reservation
+    from ..resource_management.memory_manager import MemoryInfo
+    from ..topology.node import QuantumRouter
+
+
+class App(ABC):
+    """Abstract base application attached to a quantum network node.
+
+    Every concrete application must subclass `App` and implement the three
+    abstract callback methods that `QuantumRouter` relies on.
+
+    The constructor automatically registers the application on the node via
+    `node.set_app(self)`, so subclasses should always call
+    `super().__init__(node)`!
+
+    Attributes:
+        node (QuantumRouter): The node this application is attached to.
+        name (str): Human-readable name for the application instance.
+    """
+
+    def __init__(self, node: QuantumRouter):
+        self.node: QuantumRouter = node
+        self.node.set_app(self)
+        self.name: str = f"{self.node.name}.{self.__class__.__name__}"
+
+    @abstractmethod
+    def get_memory(self, info: MemoryInfo) -> None:
+        """Called when an entangled memory becomes available.
+
+        Args:
+            info (MemoryInfo): Information about the available memory.
+        """
+        pass
+
+    @abstractmethod
+    def get_reservation_result(self, reservation: Reservation, result: bool) -> None:
+        """Called when a reservation result is received from the network manager.
+
+        Args:
+            reservation (Reservation): The reservation that completed.
+            result (bool): Whether the reservation was approved.
+        """
+        pass
+
+    @abstractmethod
+    def get_other_reservation(self, reservation: Reservation) -> None:
+        """Called when a reservation initiated by another node is approved and
+        uses this node as the responder.
+
+        Args:
+            reservation (Reservation): The approved reservation.
+        """
+        pass
+
+    def set_name(self, name: str) -> None:
+        """Override the default application name.
+
+        Args:
+            name (str): New name for the application.
+        """
+        self.name = name
+
+    def __str__(self) -> str:
+        return self.name

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/sequence/app/request_app.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+import warnings
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -6,12 +7,14 @@ if TYPE_CHECKING:
     from ..network_management.reservation import Reservation
     from ..resource_management.memory_manager import MemoryInfo
 
+from .app import App
 from ..kernel.event import Event
 from ..kernel.process import Process
-from ..utils import log
+from ..utils import log, metrics
+from ..utils.metrics.event_types import EventTypes
 
 
-class RequestApp:
+class RequestApp(App):
     """Code for the request application.
 
         This application will create a request for entanglement.
@@ -35,8 +38,7 @@ class RequestApp:
     """
 
     def __init__(self, node: QuantumRouter):
-        self.node: QuantumRouter = node
-        self.node.set_app(self)
+        super().__init__(node)
         self.responder: str = ""
         self.start_t: int = -1
         self.end_t: int = -1
@@ -46,7 +48,6 @@ class RequestApp:
         self.memory_counter: int = 0
         self.path: list[str] = []
         self.memo_to_reservation: dict[int, Reservation] = {}
-        self.name: str = f"{self.node.name}.RequestApp"
 
     def start(self, responder: str, start_t: int, end_t: int, memo_size: int, fidelity: float):
         """Method to start the application.
@@ -135,14 +136,19 @@ class RequestApp:
 
         if info.index in self.memo_to_reservation:
             reservation = self.memo_to_reservation[info.index]
-            if info.remote_node == reservation.initiator and info.fidelity >= reservation.fidelity:
+            valid_fidelity = info.fidelity >= reservation.fidelity
+            if info.remote_node == reservation.initiator and valid_fidelity:
                 self.node.resource_manager.update(None, info.memory, "RAW")
-            elif info.remote_node == reservation.responder and info.fidelity >= reservation.fidelity:
+                metrics.record(EventTypes.DELIVERY, self.node.name, fidelity=info.fidelity, **reservation)
+            elif info.remote_node == reservation.responder and valid_fidelity:
                 self.memory_counter += 1
                 log.logger.info(f"Successfully generated entanglement. Counter is at {self.memory_counter}.")
                 self.node.resource_manager.update(None, info.memory, "RAW")
+                metrics.record(EventTypes.DELIVERY, self.node.name, fidelity=info.fidelity, **reservation)
 
     def get_throughput(self) -> float:
+        warnings.warn("get_throughput is deprecated and will be removed in a future release, "
+                      "use THROUGHPUT_METRIC from the metrics module instead", category=FutureWarning, stacklevel=2)
         return self.memory_counter / (self.end_t - self.start_t) * 1e12
 
 
@@ -167,8 +173,3 @@ class RequestApp:
                 event = Event(reservation.end_time, process)
                 self.node.timeline.schedule(event)
 
-    def set_name(self, name: str):
-        self.name = name
-
-    def __str__(self) -> str:
-        return self.name

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/sequence/components/circuit.py

@@ -3,68 +3,48 @@
 This module introduces the QuantumCircuit class. The qutip library is used to calculate the unitary matrix of a circuit.
 """
 
-from math import e, pi, sqrt
-
 import numpy as np
 from qutip_qip.circuit import QubitCircuit
 from qutip_qip.operations import gate_sequence_product
 from qutip import Qobj
 
+from ..kernel.quantum_gates import gate_matrix
+
 GATE_INFO_TYPE = list[str | list[int] | float]
 
 
 def x_gate():
-    mat = np.array([[0, 1],
-                    [1, 0]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("x"), dims=[[2], [2]])
 
 
 def y_gate():
-    mat = np.array([[0, -1.j],
-                    [1.j, 0]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("y"), dims=[[2], [2]])
 
 
 def z_gate():
-    mat = np.array([[1, 0],
-                    [0, -1]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("z"), dims=[[2], [2]])
 
 
 def s_gate():
-    mat = np.array([[1.,   0],
-                    [0., 1.j]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("s"), dims=[[2], [2]])
 
 def sdg_gate():
-    mat = np.array([[1.,   0],
-                    [0., -1.j]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("sdg"), dims=[[2], [2]])
 
 def t_gate():
-    mat = np.array([[1.,   0],
-                    [0., e ** (1.j * (pi / 4))]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("t"), dims=[[2], [2]])
 
 def root_iZ_gate():
-    mat = 1/sqrt(2)*np.array([[1.+1.j,   0],
-                              [0, 1.-1.j]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("root_iZ"), dims=[[2], [2]])
 
 def minus_root_iZ_gate():
-    mat = 1/sqrt(2)*np.array([[1.-1.j,   0],
-                              [0, 1.+1.j]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("minus_root_iZ"), dims=[[2], [2]])
 
 def root_iY_gate():
-    mat = 1/sqrt(2)*np.array([[1.,   1.],
-                              [-1., 1.]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("root_iY"), dims=[[2], [2]])
 
 def minus_root_iY_gate():
-    mat = 1/sqrt(2)*np.array([[1.,   -1.],
-                              [1., 1.]])
-    return Qobj(mat, dims=[[2], [2]])
+    return Qobj(gate_matrix("minus_root_iY"), dims=[[2], [2]])
 
 
 def validator(func):

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/sequence/constants.py

@@ -43,6 +43,9 @@ MILLISECOND: Final = 10**9
 #: Number of picoseconds in one second.
 SECOND:      Final = 10**12
 
+
+# Formalism #
+
 #: Built-in ket-vector formalism identifier.
 KET_VECTOR_FORMALISM: Final = "ket_vector"
 #: Built-in density-matrix formalism identifier.
@@ -54,7 +57,12 @@ BELL_DIAGONAL_STATE_FORMALISM: Final = "bell_diagonal"
 #: Built-in stabilizer-state formalism identifier.
 STABILIZER_FORMALISM: Final = "stabilizer"
 
+
+# Protocol Type #
+
 #: Built-in Barrett-Kok generation protocol identifier.
 BARRET_KOK: Final = 'barret_kok'
 #: Built-in single-heralded generation protocol identifier.
 SINGLE_HERALDED: Final = 'single_heralded'
+#: Built-in DEJMPS Bell-diagonal-state purification protocol identifier.
+DEJMPS: Final = "dejmps_bds"

{sequence-1.0.0.dev1539950 → sequence-1.2.0}/sequence/entanglement_management/entanglement_protocol.py

@@ -8,6 +8,8 @@ if TYPE_CHECKING:
     from ..components.memory import Memory
 
 from ..protocol import Protocol
+from ..utils import metrics
+from ..utils.metrics.event_types import EventTypes
 
 
 class EntanglementProtocol(Protocol):
@@ -80,3 +82,10 @@ class EntanglementProtocol(Protocol):
 
         self.owner.resource_manager.update(self, memory, state)
 
+    def record_memory_expired(self, memory: "Memory") -> None:
+        """Record a MEMORY_EXPIRED metrics event for the given memory."""
+        memo_info = self.owner.resource_manager.memory_manager.get_info_by_memory(memory)
+        identity = None
+        if self.rule is not None and self.rule.reservation is not None:
+            identity = self.rule.reservation.identity
+        metrics.record(EventTypes.MEMORY_EXPIRED, self.owner.name, memory_index=memo_info.index, identity=identity)