emu-base 1.2.3__py3-none-any.whl → 1.2.5__py3-none-any.whl

emu_base/__init__.py

@@ -44,4 +44,4 @@ __all__ = [
     "DEFAULT_MAX_KRYLOV_DIM",
 ]
 
-__version__ = "1.2.3"
+__version__ = "1.2.5"

emu_base/base_classes/config.py

@@ -3,6 +3,11 @@ from pulser.noise_model import NoiseModel
 import logging
 import sys
 import pathlib
+from typing import TYPE_CHECKING
+import torch
+
+if TYPE_CHECKING:
+    from emu_base.base_classes.callback import Callback
 
 
 class BackendConfig:
@@ -30,8 +35,7 @@ class BackendConfig:
     def __init__(
         self,
         *,
-        # "Callback" is a forward type reference because of the circular import otherwise.
-        observables: list["Callback"] | None = None,  # type: ignore # noqa: F821
+        observables: list[Callback] | None = None,
         with_modulation: bool = False,
         noise_model: NoiseModel = None,
         interaction_matrix: list[list[float]] | None = None,
@@ -47,29 +51,36 @@ class BackendConfig:
         self.with_modulation = with_modulation
         self.noise_model = noise_model
 
-        if interaction_matrix is not None and (
-            not isinstance(interaction_matrix, list)
-            or not isinstance(interaction_matrix[0], list)
+        if interaction_matrix is not None and not (
+            isinstance(interaction_matrix, list)
+            and isinstance(interaction_matrix[0], list)
+            and isinstance(interaction_matrix[0][0], float)
         ):
             raise ValueError(
                 "Interaction matrix must be provided as a Python list of lists of floats"
             )
 
+        if interaction_matrix is not None:
+            int_mat = torch.tensor(interaction_matrix)
+            tol = 1e-10
+            if not (
+                int_mat.numel() != 0
+                and torch.all(torch.isreal(int_mat))
+                and int_mat.dim() == 2
+                and int_mat.shape[0] == int_mat.shape[1]
+                and torch.allclose(int_mat, int_mat.T, atol=tol)
+                and torch.norm(torch.diag(int_mat)) < tol
+            ):
+                raise ValueError("Interaction matrix is not symmetric and zero diag")
+
         self.interaction_matrix = interaction_matrix
         self.interaction_cutoff = interaction_cutoff
         self.logger = logging.getLogger("global_logger")
-        if log_file is None:
-            logging.basicConfig(
-                level=log_level, format="%(message)s", stream=sys.stdout, force=True
-            )  # default to stream = sys.stderr
-        else:
-            logging.basicConfig(
-                level=log_level,
-                format="%(message)s",
-                filename=str(log_file),
-                filemode="w",
-                force=True,
-            )
+        self.log_file = log_file
+        self.log_level = log_level
+
+        self.init_logging()
+
         if noise_model is not None and (
             noise_model.runs != 1
             or noise_model.samples_per_run != 1
@@ -79,3 +90,17 @@ class BackendConfig:
             self.logger.warning(
                 "Warning: The runs and samples_per_run values of the NoiseModel are ignored!"
             )
+
+    def init_logging(self) -> None:
+        if self.log_file is None:
+            logging.basicConfig(
+                level=self.log_level, format="%(message)s", stream=sys.stdout, force=True
+            )  # default to stream = sys.stderr
+        else:
+            logging.basicConfig(
+                level=self.log_level,
+                format="%(message)s",
+                filename=str(self.log_file),
+                filemode="w",
+                force=True,
+            )

emu_base/math/krylov_exp.py

@@ -21,7 +21,7 @@ class KrylovExpResult:
 
 
 def krylov_exp_impl(
-    op: Callable,
+    op: Callable[[torch.Tensor], torch.Tensor],
     v: torch.Tensor,
     is_hermitian: bool,  # note: complex-proportional to its adjoint is enough
     exp_tolerance: float,
@@ -103,7 +103,7 @@ def krylov_exp_impl(
 
 
 def krylov_exp(
-    op: torch.Tensor,
+    op: Callable[[torch.Tensor], torch.Tensor],
     v: torch.Tensor,
     exp_tolerance: float,
     norm_tolerance: float,

emu_base/pulser_adapter.py

@@ -62,7 +62,7 @@ def _xy_interaction(sequence: pulser.Sequence) -> torch.Tensor:
     qubit_positions = _get_qubit_positions(sequence.register)
     interaction_matrix = torch.zeros(num_qubits, num_qubits)
     mag_field = torch.tensor(sequence.magnetic_field)  # by default [0.0,0.0,30.0]
-    mag_norm = torch.norm(mag_field)
+    mag_norm = torch.linalg.norm(mag_field)
 
     for numi in range(len(qubit_positions)):
         for numj in range(numi + 1, len(qubit_positions)):
@@ -70,7 +70,10 @@ def _xy_interaction(sequence: pulser.Sequence) -> torch.Tensor:
             if mag_norm >= 1e-8:  # selected by hand
                 cosine = torch.dot(
                     (qubit_positions[numi] - qubit_positions[numj]), mag_field
-                ) / (torch.norm(qubit_positions[numi] - qubit_positions[numj]) * mag_norm)
+                ) / (
+                    torch.linalg.norm(qubit_positions[numi] - qubit_positions[numj])
+                    * mag_norm
+                )
 
             interaction_matrix[numi][numj] = (
                 c3  # check this value with pulser people
@@ -155,17 +158,26 @@ def _extract_omega_delta_phi(
                 global_times |= set(i for i in range(slot.ti, slot.tf))
 
     step = 0
-    t = int((step + 1 / 2) * dt)
+    t = (step + 1 / 2) * dt
 
     while t < max_duration:
         for q_pos, q_id in enumerate(sequence.register.qubit_ids):
-            omega[step, q_pos] = locals_a_d_p[q_id]["amp"][t]
-            delta[step, q_pos] = locals_a_d_p[q_id]["det"][t]
-            phi[step, q_pos] = locals_a_d_p[q_id]["phase"][t]
+            omega[step, q_pos] = (
+                locals_a_d_p[q_id]["amp"][math.floor(t)]
+                + locals_a_d_p[q_id]["amp"][math.ceil(t)]
+            ) / 2.0
+            delta[step, q_pos] = (
+                locals_a_d_p[q_id]["det"][math.floor(t)]
+                + locals_a_d_p[q_id]["det"][math.ceil(t)]
+            ) / 2.0
+            phi[step, q_pos] = (
+                locals_a_d_p[q_id]["phase"][math.floor(t)]
+                + locals_a_d_p[q_id]["phase"][math.ceil(t)]
+            ) / 2.0
         if t in global_times:
             omega[step] *= waist_factors
         step += 1
-        t = int((step + 1 / 2) * dt)
+        t = (step + 1 / 2) * dt
 
     return omega, delta, phi
 

emu_base/utils.py

@@ -1,9 +1,9 @@
 import torch
 
 
-def dist2(left: torch.tensor, right: torch.tensor) -> torch.Tensor:
-    return torch.norm(left - right) ** 2
+def dist2(left: torch.Tensor, right: torch.Tensor) -> float:
+    return torch.dist(left, right).item() ** 2
 
 
-def dist3(left: torch.tensor, right: torch.tensor) -> torch.Tensor:
-    return torch.norm(left - right) ** 3
+def dist3(left: torch.Tensor, right: torch.Tensor) -> float:
+    return torch.dist(left, right).item() ** 3

emu_base-1.2.5.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: emu-base
+Version: 1.2.5
+Summary: Pasqal base classes for emulators
+Author-email: Anton Quelle <anton.quelle@pasqal.com>, Mauro Mendizabal <mauro.mendizabal-pico@pasqal.com>, Stefano Grava <stefano.grava@pasqal.com>, Pablo Le Henaff <pablo.le-henaff@pasqal.com>
+License: PASQAL OPEN-SOURCE SOFTWARE LICENSE AGREEMENT (MIT-derived)
+        
+        The author of the License is:
+          Pasqal, a Société par Actions Simplifiée (Simplified Joint Stock Company) registered under number 849 441 522 at the Registre du commerce et des sociétés (Trade and Companies Register) of Evry – France, headquartered at 7 rue Leonard de Vinci – 91300 – Massy – France, duly represented by its Président, M. Georges-Olivier REYMOND,
+        
+        Hereafter referred to as « the Licensor »
+        
+        - Permission is hereby granted, free of charge, to any person obtaining a copy of this software (the “Licensee”) and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The Software is “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise arising from, out of or in connection with the Software or the use or other dealings in the Software.
+        
+        - If use of the Software leads to the necessary use of any patent of the Licensor and/or any of its Affiliates (defined as a company owned or controlled by the Licensor), the Licensee is granted a royalty-free license, in any country where such patent is in force, to use the object of such patent; or use the process covered by such patent,
+        
+        - Such a patent license is granted for internal research or academic use of the Licensee's, which includes use by employees and students of the Licensee, acting on behalf of the Licensee, for research purposes only.
+        
+        - The License is governed by the laws of France. Any dispute relating to the License, notably its execution, performance and/or termination shall be brought to, heard and tried by the Tribunal Judiciaire de Paris, regardless of the rules of jurisdiction in the matter.
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: pulser-core==1.3.*
+Requires-Dist: torch==2.5.0
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="docs/logos/LogoTaglineSoftGreen.svg">
+
+  # Emu-MPS
+</div>
+
+**Emu-mps** is a backend for the [Pulser low-level Quantum Programming toolkit](https://pulser.readthedocs.io) that lets you run Quantum Algorithms on a simulated device, using GPU acceleration if available. More in depth, emu-mps is designed to **emu**late the dynamics of programmable arrays of neutral atoms, with matrix product states (**mps**). While benchmarking is incomplete as of this writing, early results suggest that this design makes emu-mps faster and more memory-efficient than previous generations of quantum emulators at running simulations with large numbers of qubits.
+
+As of this writing, Emu-MPS is provided for Linux and macOS but will not work under Windows.
+
+## Installation
+
+**Warning:** installing emu-mps will update pulser-core
+
+### Using `hatch`, `uv` or any pyproject-compatible Python manager
+
+To add `emu-mps` to your project, edit your `pyproject.toml` to add the line
+
+```toml
+  "emu-mps"
+```
+
+to the list of `dependencies`.
+
+
+### Using `pip` or `pipx`
+To install the `pipy` package using `pip` or `pipx`
+
+1. Create a `venv` if that's not done yet
+
+```sh
+$ python -m venv venv
+
+```
+
+2. Enter the venv
+
+If you're running Unix:
+
+```sh
+$ . venv/bin/activate
+```
+
+If you're running Windows:
+
+```sh
+C:\> /path/to/new/virtual/environment/Scripts/activate
+```
+
+3. Install the package
+
+```sh
+$ pip install emu-mps
+# or
+$ pipx install emu-mps
+```
+
+
+Join us on [Slack](https://pasqalworkspace.slack.com/archives/C07MUV5K7EU) or by [e-mail](mailto:emulation@pasqal.com) to give us feedback about how you plan to use Emu-MPS or if you require specific feature-upgrades.
+
+## Usage
+
+For the time being, the easiest way to learn how to use this package is to look
+at the [examples](examples/emu_mps_examples) and [notebooks](https://pasqal-io.github.io/emulators/latest/).
+
+See also the [full documentation](https://github.com/pasqal-io/emulators/blob/main/docs/index.md) for
+the API, information about contributing, benchmarks, etc.
+
+
+## Getting in touch
+
+- [Pasqal Community Portal](https://community.pasqal.com/) (forums, chat, tutorials, examples, code library).
+- [GitHub Repository](https://github.com/pasqal-io/quantum-evolution-kernel) (source code, issue tracker).
+- [Professional Support](https://www.pasqal.com/contact-us/) (if you need tech support, custom licenses, a variant of this library optimized for your workload, your own QPU, remote access to a QPU, ...)

{emu_base-1.2.3.dist-info → emu_base-1.2.5.dist-info}/RECORD

@@ -1,19 +1,19 @@
-emu_base/__init__.py,sha256=SzA_qsfvzoNa6H1nsRR_o8HEDG6mt8hgX2dWXt-MIVI,1130
+emu_base/__init__.py,sha256=5X57qf5fo0zv8vmeaDbrW9ThsAEIjy5HPsCpQEIL8iI,1130
 emu_base/lindblad_operators.py,sha256=eXkXsLt_fV7jhF31EkxzYFU04rOJV3uWXsl6t1aTAqs,1562
-emu_base/pulser_adapter.py,sha256=AjBT9CM0HX5vh8JaU1wRZq1QgXVAryAsYMNKmtPk9x4,8730
-emu_base/utils.py,sha256=YCi7UngUzZYSOONhecUdFSB_OkH_aadMTvixzqHYYAc,235
+emu_base/pulser_adapter.py,sha256=vnIiOpjJBXEwMmuWqOdRIlHmkkYnvvPmsSfRNPzBi2k,9118
+emu_base/utils.py,sha256=RM8O0qfPAJfcdqqAojwEEKV7I3ZfVDklnTisTGhUg5k,233
 emu_base/base_classes/__init__.py,sha256=Su6fHtjCyg0fw-7y7e7nbMfDASppNRQs8iGaAOkO3c4,570
 emu_base/base_classes/aggregators.py,sha256=bcvoGfZCkPKv-CI29gTma6HBphGh7bjBq2Ome77eRJM,1840
 emu_base/base_classes/backend.py,sha256=7tnwb9MnRbwRN1_JTqliYftjqExuOE-Rrwz9AU2Pc4c,1645
 emu_base/base_classes/callback.py,sha256=JXah_ZDNM8iyPWy7IOwW481qRFyqVvlSM-0OkjBzV0A,3055
-emu_base/base_classes/config.py,sha256=e7ZRNcBBTEfD_TrODZqCRncvOTUs07TivH04dKaiXrI,3333
+emu_base/base_classes/config.py,sha256=Dg2CwC9sc5HYwszQAJSVjkSd3wuQrv6aEZGYBRnFl48,4098
 emu_base/base_classes/default_callbacks.py,sha256=F44kkuwWdVcvMGZ9vJ2q7ug-_P8IQyJv-SVxSVWHW_w,9940
 emu_base/base_classes/operator.py,sha256=MJjuDUTwJLbaSJzSNCKDWGvmGCGAEIEWISLoPSSzNsU,3501
 emu_base/base_classes/results.py,sha256=7-Mz3jmFy19hd3PIA5idK610mC3b5jOf3EKBmV14Jv4,5569
 emu_base/base_classes/state.py,sha256=7iIyZmBqqJ6G4SyYZ3kyylWjAqiYIx0aW5B0T74EPZI,2707
 emu_base/math/__init__.py,sha256=6BbIytYV5uC-e5jLMtIErkcUl_PvfSNnhmVFY9Il8uQ,97
 emu_base/math/brents_root_finding.py,sha256=AVx6L1Il6rpPJWrLJ7cn6oNmJyZOPRgEaaZaubC9lsU,3711
-emu_base/math/krylov_exp.py,sha256=TKvlByRKfCNZdS_YcfCtTk4D7YGhJ-2eIylLVT-X7i4,3784
-emu_base-1.2.3.dist-info/METADATA,sha256=f5VhLnKJDOGLnCqeQcUc91uf-o0oS7DhAlX05eFXH2A,4220
-emu_base-1.2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-emu_base-1.2.3.dist-info/RECORD,,
+emu_base/math/krylov_exp.py,sha256=UCFNeq-j2ukgBsOPC9_Jiv1aqpy88SrslDLiCxIGBwk,3840
+emu_base-1.2.5.dist-info/METADATA,sha256=wD4pmz4VvisVEZmM3Z44CC_fiwB6SMw-O9fFKPHvb7w,5576
+emu_base-1.2.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+emu_base-1.2.5.dist-info/RECORD,,

emu_base-1.2.3.dist-info/METADATA

@@ -1,134 +0,0 @@
-Metadata-Version: 2.4
-Name: emu-base
-Version: 1.2.3
-Summary: Pasqal base classes for emulators
-Author-email: Anton Quelle <anton.quelle@pasqal.com>, Mauro Mendizabal <mauro.mendizabal-pico@pasqal.com>, Stefano Grava <stefano.grava@pasqal.com>, Pablo Le Henaff <pablo.le-henaff@pasqal.com>
-License: Proprietary
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.10
-Requires-Dist: pulser-core==1.1.*
-Requires-Dist: torch==2.5.0
-Description-Content-Type: text/markdown
-
-<div align="center">
-  <img src="docs/logos/LogoTaglineSoftGreen.svg">
-
-  # Emu-MPS
-</div>
-
-**EMU-MPS** is a Pulser backend, designed to **EMU**late the dynamics of programmable arrays of neutral atoms, with matrix product states (**MPS**). It allows users to increase the number of qubits and reduce computation time.
-
-Join us on [Slack](https://pasqalworkspace.slack.com/archives/C07MUV5K7EU) or by [e-mail](mailto:emulation@pasqal.com) to give us feedback about how you plan to use Emu-MPS or if you require specific feature-upgrades.
-
-
-## Getting started
-
-You can install from source, or download the package from the private pypi registry that pasqal maintains in gitlab.
-For developers, we recommend installing from source, for users we recommend installing from the registry.
-
-**Warning:** installing emu-mps will update pulser-core
-
-We always recommend using a virtual environment.
-
-<details>
-  <summary>Click me to see how it is done</summary>
-
-  #### Create a virtual environment using python
-
-  ```
-  python -m venv .venv
-  ```
-
-  Or
-
-  ```
-  python -m venv /path/to/new/virtual/environment
-  ```
-
-  Replace `/path/to/new/virtual/environment` with your desired directory path.
-
-  Then activate the environment On linux or MacOS
-
-  ```
-  source /path/to/new/virtual/environment/bin/activate
-  ```
-
-  While on Windows it's
-
-  ```
-  C:\> /path/to/new/virtual/environment/Scripts/activate
-  ```
-
-  Remember to replace `/path/to/new/virtual/environment` with the actual path to your virtual environment. Once the environment is activated, you can clone emu_mps and install it using
-
-</details>
-
-### installing from the registry
-
-When pip is configured to know about the pasqal registry, Emu-MPS installs as
-
-```bash
-pip install emu-mps
-```
-When pip is not already configured, the easiest way to do so, is to add a file `~/.config/pip/pip.conf` containing:
-
-```
-[global]
-extra-index-url=https://gitlab.pasqal.com/api/v4/projects/597/packages/pypi/simple
-                possible.other.urls
-```
-
-As this shows, it is also possible to have multiple extra repositories configured. Note that the order is not important.
-
-It is also possible to add the `extra-index-url` to the `pip install` command directly, if you somehow don't want to create a `pip.conf` file.
-
-### installing from source
-git clone this [repository ](https://gitlab.pasqal.com/emulation/rydberg-atoms/emu-ct) or download
-
-
-Then, `cd` into the root folder of the repo and type
-
-```bash
-pip install -e .
-```
-
-<details>
-  <summary>Guidelines for developers </summary>
-  We recommend using an environment, git clone the repository, then inside the `emu_mps` folder
-
-```bash
-pip install -e .
-```
-
-  Also, the installation of pytest, nbmake, pre-commit.
-
-  Do not forget to run the unit test suite by simply running `pytest` command.
-
-  Another way can be using hatch.
-
-  #### virtual environment with `hatch`
-
-  ```bash
-  python -m pip install hatch
-  python -m hatch -v shell
-  ```
-
-  When inside the shell with development dependencies, install first the pre-commit hook:
-  ```
-  pre-commit install
-  ```
-</details>
-
-## Check the tutorial notebooks and example scripts
-
-For more information, you can check the tutorials and examples located in the [examples folder](https://gitlab.pasqal.com/emulation/rydberg-atoms/emu-ct/-/tree/main/examples?ref_type=heads)
-
-## Documentation
-
-Please check the [documentation](./docs/index.md) page for more info about contributing, the API, benchmarks, etc.
-
-
-![Code Coverage](https://img.shields.io/badge/Coverage-95%25-brightgreen.svg)