https://github.com/cda-tum/mqt-ion-shuttler
MQT IonShuttler - generate shuttling schedules for QCCD architectures
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.8%) to scientific vocabulary
Repository
MQT IonShuttler - generate shuttling schedules for QCCD architectures
Basic Info
Statistics
- Stars: 21
- Watchers: 3
- Forks: 3
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
MQT IonShuttler
MQT IonShuttler is a tool for generating shuttling schedules for trapped-ion quantum computers with a grid-type Memory Zone based on the Quantum Charge Coupled Device (QCCD) architecture. It supports:
- exact shuttling schedules for small architectures with a single processing zone (PZ), and
- heuristic shuttling schedules for larger devices with one or multiple processing zones.
Figure 1: (a) Potential QCCD device with four processing zones; (b) corresponding graph abstraction.
The exact solution guarantees optimality but is limited to a single PZ, while the heuristic method scales to many qubits and PZs. In the heuristic workflow, an optional **compilation** feature (`use_dag`) allows for dynamic rescheduling of gates based on the current ion positions and dependencies, potentially reducing shuttling overhead compared to executing a fixed sequence. MQT IonShuttler is part of the [_Munich Quantum Toolkit_](https://mqt.readthedocs.io) (MQT) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/). If you have any questions, feel free to contact us via [quantum.cda@xcit.tum.de](mailto:quantum.cda@xcit.tum.de) or by creating an [issue](https://github.com/cda-tum/mqt-ion-shuttler/issues) on GitHub. ## Contributors and Supporters The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software). Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem, which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.
Installation
We strongly recommend using virtual environments.
To install MQT IonShuttler and its dependencies, you can use pip:
bash
pip install mqt.ionshuttler
This will install the library components from PyPI, making them importable in your Python projects.
Getting Started with Example Scripts
The runexact.py and runheuristic.py scripts provide examples of how to use MQT IonShuttler. To run these scripts and access the example configuration files, it's best to clone the repository:
bash
git clone https://github.com/cda-tum/mqt-ion-shuttler.git
cd mqt-ion-shuttler
Then, set up a virtual environment and install the package (which also installs dependencies):
```bash python3 -m venv .venv . .venv/bin/activate # Or ..venv\Scripts\activate on Windows pip install . # Installs the package and its dependencies
For development, you might prefer: pip install -e . (editable install)
``
Once this is done, you can run the example scripts as shown below. These scripts currently import modules usingfrom src...` and are designed to be run from the root of the cloned repository after the local installation.
Exact Solution (single PZ)
```bash python3 -m venv .venv . .venv/bin/activate pip install . python3 run_exact.py --help
Example
python3 runexact.py algorithmsexact/qft_06.json ```
The script supports an additional --plot argument to visualise the result. All parameters are documented via --help.
Architectures and algorithms are specified in JSON files—see the examples in algorithms_exact/.
Heuristic Solution (single & multiple PZs)
```bash python3 -m venv .venv . .venv/bin/activate pip install . python3 run_heuristic.py --help
Example with 60 qubits executed on 4 PZs
python3 runheuristic.py algorithmsheuristic/qft604pzs.json ```
Architectures and algorithms are specified in JSON files—see the examples in algorithms_heuristic/.
References
This implementation is based on the following publications:
- D. Schoenberger, S. Hillmich, M. Brandl, and R. Wille, "Using Boolean Satisfiability for Exact Shuttling in Trapped-Ion Quantum Computers," ASP-DAC, 2024.
- D. Schoenberger, S. Hillmich, M. Brandl, and R. Wille, "Shuttling for Scalable Trapped-Ion Quantum Computers," IEEE TCAD, 2024.
- D. Schoenberger, R. Wille, "Orchestrating Multi-Zone Shuttling in Trapped-Ion Quantum Computers".
Acknowledgements
The Munich Quantum Toolkit has been supported by the European Union's Horizon 2020 research and innovation programme (DA QC, grant agreement No. 101001318 and MILLENION, grant agreement No. 101114305), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.
Owner
- Name: Chair for Design Automation, TU Munich
- Login: cda-tum
- Kind: organization
- Location: Germany
- Website: https://www.cda.cit.tum.de
- Repositories: 22
- Profile: https://github.com/cda-tum
The CDA provides expertise for all main steps in the design and realization of integrated circuits, embedded systems, as well as cyber-physical systems.
GitHub Events
Total
- Watch event: 10
- Delete event: 1
- Push event: 43
- Pull request event: 12
- Fork event: 1
- Create event: 5
Last Year
- Watch event: 10
- Delete event: 1
- Push event: 43
- Pull request event: 12
- Fork event: 1
- Create event: 5
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Daniel Schoenberger | s****l@o****m | 127 |
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 1
- Total pull requests: 18
- Average time to close issues: 2 days
- Average time to close pull requests: 2 days
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 13
- Average time to close issues: N/A
- Average time to close pull requests: 3 days
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- burgholzer (1)
Pull Request Authors
- danielschoenberger (17)
- dependabot[bot] (2)
- hillmich (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: mqt-ion-shuttler
A solver for the shuttling problem in QCCD quantum computers
- Documentation: https://mqt-ion-shuttler.readthedocs.io/
- License: MIT License Copyright (c) 2023 Daniel Schönberger Permission is hereby granted, free of charge, to any person obtaining a copy of this software 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 PROVIDED "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 NONINFRINGEMENT. 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.
- Status: removed
-
Latest release: 0.1
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- matplotlib ==3.7.1
- networkx ==3.0
- z3-solver ==4.12.1.0