spin-pulse 1.0__tar.gz

spin_pulse-1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

spin_pulse-1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

spin_pulse-1.0/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,15 @@
+# Description of the PR
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+- [ ] This change requires a notebook update

spin_pulse-1.0/.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Build & deploy spinx
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+     pages: write
+     id-token: write
+
+    environment:
+     name: github-pages
+     url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          git fetch --prune --unshallow
+          pip install uv
+          uv venv
+          source .venv/bin/activate
+          uv pip install . --group docs
+          uv run sphinx-build docs/source docs/docs_output -W -b html
+
+      - name: Verify Sphinx output
+        run: |
+          echo "Contents of docs/docs_output:"
+          ls -la docs/docs_output
+          test -f docs/docs_output/index.html
+
+      - name: Upload static files as artifact
+        id: artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/docs_output/
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

spin_pulse-1.0/.github/workflows/push-update.yml

@@ -0,0 +1,33 @@
+name: Publish to Test PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Publish to Test PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine upload dist/*

spin_pulse-1.0/.github/workflows/test.yml

@@ -0,0 +1,75 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  lint:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: linting
+        run: |
+          pip install ruff
+          ruff format src tests --check
+
+      - name: formatting
+        run: |
+          pip install ruff
+          ruff format src tests --check
+
+      - name: typing
+        run: |
+          pip install uv
+          uv venv
+          source .venv/bin/activate
+          uv pip install . --group lint
+          mypy src
+        
+          echo Add other actions to build,
+          echo test, and deploy your project.
+
+  tests:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: tests
+        run: |
+          git fetch --prune --unshallow
+          pip install uv
+          pip install pytest-mock
+          pip install pytest pytest-cov
+          uv venv
+          source .venv/bin/activate
+          uv pip install -e . --group test
+          pytest tests --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
+
+      - name: Upload pytest test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: pytest-results-${{ matrix.python-version }}
+          path: junit/test-results-${{ matrix.python-version }}.xml

spin_pulse-1.0/.gitignore

@@ -0,0 +1,87 @@
+# Fichiers Python compilés
+__pycache__/
+*.py[cod]
+*.so
+
+# Auto generated version file
+*/spin_pulse/version.py
+
+
+# Fichiers d'exécution temporaires
+*.log
+*.out
+*.tmp
+*.bak
+
+# Environnement virtuel
+env/
+venv/
+.venv/
+.envrc
+requirement.txt
+
+# Jupyter Notebook checkpoints + files
+.ipynb_checkpoints/
+
+# pytest file
+.coverage
+
+# Fichiers IDE
+.vscode/
+.idea/
+*.swp
+
+# Fichiers système
+.DS_Store
+Thumbs.db
+
+# Dossiers de build
+build/
+dist/
+*.egg-info/
+
+# Configuration personnelle
+*.env
+.env.*
+
+# API doc files
+*.pickle
+*.doctree
+*.html
+*.inv
+*.css
+*.mo
+*.po
+*.map
+*.ttf
+*.woff2
+
+# LaTeX temporary files
+*.aux
+*.log
+*.toc
+*.fls
+
+# PDF output - usually a bad idea to keep this in Git
+#main.pdf
+
+# Latexmk
+*.fdb_latexmk
+
+# SyncTeX
+*.synctex.gz
+
+# ZoneIdentifier
+**/*Zone.Identifier
+
+# Mypy
+.dmypy.json
+
+# Autobuilt api docs
+docs/build
+docs/_build/
+_build/
+docs_output/
+_build/
+coverage.xml
+jupyter_execute/

spin_pulse-1.0/LICENCE.txt

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

spin_pulse-1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: spin_pulse
+Version: 1.0
+Summary: Quobly noise accurate simulation toolbox.
+Author-email: Benoit Vermersch <benoit.vermersch@quobly.io>, Oscar Gravier <oscar.gravier@gmail.com>, "Matthieu C. Dartiailh" <matthieu.dartiailh@quobly.io>, Julia Guignon <julia.guignon@quobly.io>, Nathan Miscopein <nathan.miscopein@quobly.io>, Carlos Ramos Marimon <carlos.marimon@quobly.io>, Jonathan Durandau <jonathan.durandau@quobly.io>, Tristan Meunier <tristan.meunier@quobly.io>, Valentin Savin <valentin.savin@quobly.io>
+Project-URL: homepage, https://github.com/quobly-sw/SpinPulse
+Project-URL: repository, https://github.com/quobly-sw/SpinPulse
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENCE.txt
+Requires-Dist: numpy>=2.1
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: qiskit>=2
+Requires-Dist: pylatexenc
+Requires-Dist: importlib_metadata>=8.7
+Requires-Dist: tqdm
+Requires-Dist: packaging
+Requires-Dist: setuptools_scm
+Requires-Dist: qiskit-aer
+Requires-Dist: networkx>=3.0
+Requires-Dist: llvmlite>=0.46
+Requires-Dist: numba>=0.63
+Requires-Dist: quimb>=1.10
+Dynamic: license-file
+
+<img src="https://github.com/quobly-sw/SpinPulse/raw/main/assets/SpinPulse.png" width=200>
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**`SpinPulse`** is an open-source **`python`** package for simulating spin qubit-based quantum computers at the pulse-level.
+**`SpinPulse`** models the specific physics of spin qubits, particularly through the inclusion of classical non-Markovian noise.
+This enables realistic simulations of native gates and noise-accurate quantum circuits, in order to support hardware development.
+
+This code is licensed under the Apache License, Version 2.0.
+
+<img src="https://github.com/quobly-sw/SpinPulse/raw/main/docs/source/customapi/figures/global_fig.png">
+
+
+## Installation
+
+You can install **SpinPulse** by running the following command from the root of the repository:
+```
+    pip install spin-pulse
+```
+
+For more information consult the {doc}`installation <customapi/installation/index>` page.
+
+## API & Documentation
+
+The API documentation can be found at [APIdoc](https://quobly-sw.github.io/SpinPulse/) and provides a detailed description of the **`SpinPulse`** package architecture, including its core modules, classes and functions.
+
+Detailed information on our model and the code structure is presented in our [publication]()
+
+## Citing
+
+If you use **`SpinPulse`** in your research work, please cite our publication
+
+```latex
+@misc{vermersch2026spinpulse,
+      title={The SpinPulse library for transpilation and noise-accurate simulation of spin qubit quantum computers},
+      author={Beno\^it Vermersch, Oscar Gravier, Nathan Miscopein, Julia Guignon, Carlos Ramos Marim\'on, Jonathan Durandau, Matthieu Dartiailh, Tristan Meunier and Valentin Savin},
+      year={2026},
+      eprint={2601.XXXX},
+      archivePrefix={arXiv},
+      primaryClass={quant-ph},
+      url={https://arxiv.org/abs/2601.XXXX},
+}
+```

spin_pulse-1.0/README.md

@@ -0,0 +1,43 @@
+<img src="https://github.com/quobly-sw/SpinPulse/raw/main/assets/SpinPulse.png" width=200>
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**`SpinPulse`** is an open-source **`python`** package for simulating spin qubit-based quantum computers at the pulse-level.
+**`SpinPulse`** models the specific physics of spin qubits, particularly through the inclusion of classical non-Markovian noise.
+This enables realistic simulations of native gates and noise-accurate quantum circuits, in order to support hardware development.
+
+This code is licensed under the Apache License, Version 2.0.
+
+<img src="https://github.com/quobly-sw/SpinPulse/raw/main/docs/source/customapi/figures/global_fig.png">
+
+
+## Installation
+
+You can install **SpinPulse** by running the following command from the root of the repository:
+```
+    pip install spin-pulse
+```
+
+For more information consult the {doc}`installation <customapi/installation/index>` page.
+
+## API & Documentation
+
+The API documentation can be found at [APIdoc](https://quobly-sw.github.io/SpinPulse/) and provides a detailed description of the **`SpinPulse`** package architecture, including its core modules, classes and functions.
+
+Detailed information on our model and the code structure is presented in our [publication]()
+
+## Citing
+
+If you use **`SpinPulse`** in your research work, please cite our publication
+
+```latex
+@misc{vermersch2026spinpulse,
+      title={The SpinPulse library for transpilation and noise-accurate simulation of spin qubit quantum computers},
+      author={Beno\^it Vermersch, Oscar Gravier, Nathan Miscopein, Julia Guignon, Carlos Ramos Marim\'on, Jonathan Durandau, Matthieu Dartiailh, Tristan Meunier and Valentin Savin},
+      year={2026},
+      eprint={2601.XXXX},
+      archivePrefix={arXiv},
+      primaryClass={quant-ph},
+      url={https://arxiv.org/abs/2601.XXXX},
+}
+```

spin_pulse-1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

spin_pulse-1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd