feedback-grape
feedback-grape is a high-performance Python package for simulating and optimizing quantum systems with feedback. It builds on the GRAPE (Gradient Ascent Pulse Engineering) method and introduces a new approach that integrates feedback in a natural, differentiable, and efficient way.
🚀 Features
- ✅ Vectorized, GPU-enabled, and differentiable simulations using JAX
- ✅ Efficient quantum optimal control via GRAPE
- ✅ Feedback support with the newly developed feedbackGRAPE technique
- ✅ Think of it as a parallelized, feedback-enabled, high-performance alternative to QuTiP
📦 Installation
For Users
Install the latest version via pip:
pip install feedback-grape
To enable GPU acceleration (CUDA 12):
pip install feedback-grape[cuda12]
For Developers
Install development dependencies:
pip install -U -r requirements.txt
To include tools for testing, linting, and formatting:
pip install -U -r requirements_dev.txt
To run notebooks with proper rendering:
conda install conda-forge::pandoc
To use GPU support with JAX:
pip install -U -r requirements_gpu.txt
📚 Documentation
- User Guide: https://feedbackgrape.readthedocs.io
- Developer Docs:
cd docs
make html
Open docs/build/html/index.html using a Live Server or your browser
✅ Testing & Code Quality
Run Tests
pytest
Generates test results and a coverage report.
tox
This tests the code across multiple python environments and ensures consistency.
Type Checking
mypy feedback_grape
Linting & Formatting
- Lint code:
ruff check
- Auto-format:
ruff format
📖 References
The feedbackGRAPE method was introduced in:
- Porotti, Peano, Marquardt, PRX Quantum 4, 030305 (2023)
https://journals.aps.org/prxquantum/abstract/10.1103/PRXQuantum.4.030305
It extends traditional GRAPE by incorporating feedback control, which is crucial for applications like quantum state stabilization and quantum error correction. It is designed to work seamlessly with neural networks and automatic differentiation frameworks.
A full application to quantum error correction with the GKP code is shown in:
- Puviani et al., Phys. Rev. Lett. 134, 020601 (2025)
https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.134.020601
🧠 Related Repositories
- https://github.com/rporotti/feedback_grape — Repository for feedbackGRAPE paper
- https://github.com/Matteo-Puviani/GQF — Repository for GKP quantum error correction implementation
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file feedback_grape-1.1.1.tar.gz.
File metadata
- Download URL: feedback_grape-1.1.1.tar.gz
- Upload date:
- Size: 46.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6a931e780db1af96e0e5b0e52068a1b4fd51695331d553da1952d0ff8f5743a
|
|
| MD5 |
49614b1b573ca1dd37684a7d5d6c3911
|
|
| BLAKE2b-256 |
7f4f2b8fa0aaff7ff68fb4baecc5fda87bc897705ef75cc0bc3f80bb6fda1d2c
|
Provenance
The following attestation bundles were made for feedback_grape-1.1.1.tar.gz:
Publisher:
publish_to_pypi.yml on YousefElbrolosy/feedback-grape
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
feedback_grape-1.1.1.tar.gz -
Subject digest:
f6a931e780db1af96e0e5b0e52068a1b4fd51695331d553da1952d0ff8f5743a - Sigstore transparency entry: 2423679556
- Sigstore integration time:
-
Permalink:
YousefElbrolosy/feedback-grape@736ff294a16a3f57d008c590d0cec93f15f72746 -
Branch / Tag:
refs/tags/1.1.1 - Owner: https://github.com/YousefElbrolosy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@736ff294a16a3f57d008c590d0cec93f15f72746 -
Trigger Event:
push
-
Statement type:
File details
Details for the file feedback_grape-1.1.1-py3-none-any.whl.
File metadata
- Download URL: feedback_grape-1.1.1-py3-none-any.whl
- Upload date:
- Size: 37.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
097c92fc710da9d895b8a14233123aa3dca11f25d119f8905fe1941fb5fdcd02
|
|
| MD5 |
287906cde3e5eb5aec3964f2a14190a8
|
|
| BLAKE2b-256 |
7f0c6a8f58691aada560334cb07a90ba96bf54efbf642ca78dcb7520eeacddbe
|
Provenance
The following attestation bundles were made for feedback_grape-1.1.1-py3-none-any.whl:
Publisher:
publish_to_pypi.yml on YousefElbrolosy/feedback-grape
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
feedback_grape-1.1.1-py3-none-any.whl -
Subject digest:
097c92fc710da9d895b8a14233123aa3dca11f25d119f8905fe1941fb5fdcd02 - Sigstore transparency entry: 2423679570
- Sigstore integration time:
-
Permalink:
YousefElbrolosy/feedback-grape@736ff294a16a3f57d008c590d0cec93f15f72746 -
Branch / Tag:
refs/tags/1.1.1 - Owner: https://github.com/YousefElbrolosy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@736ff294a16a3f57d008c590d0cec93f15f72746 -
Trigger Event:
push
-
Statement type:
