Qiskit Dynamics
Qiskit Dynamics: A Python package for simulating the time dynamics of quantum systems - Published in JOSS (2023)
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.5%) to scientific vocabulary
Keywords from Contributors
Scientific Fields
Repository
Tools for building and solving models of quantum systems in Qiskit
Basic Info
- Host: GitHub
- Owner: qiskit-community
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://qiskit-community.github.io/qiskit-dynamics/
- Size: 20.3 MB
Statistics
- Stars: 114
- Watchers: 8
- Forks: 60
- Open Issues: 25
- Releases: 14
Metadata Files
README.md
Qiskit Dynamics
This repo is still in the early stages of development, there will be breaking API changes
Qiskit Dynamics is an open-source project for building, transforming, and solving time-dependent quantum systems in Qiskit.
The goal of Qiskit Dynamics is to provide access to different numerical methods for solving differential equations, and to automate common processes typically performed by hand, e.g. applying frame transformations or rotating wave approximations to system and control Hamiltonians.
Qiskit Dynamics can be configured to use either NumPy or JAX as the backend for array operations. NumPy is the default, and JAX is an optional dependency. JAX provides just-in-time compilation, automatic differentiation, and GPU execution, and therefore is well-suited to tasks involving repeated evaluation of functions with different parameters; E.g. simulating a model of a quantum system over a range of parameter values, or optimizing the parameters of control sequence.
Reference documentation may be found here, including tutorials, user guide, API reference, and Discussions.
Installation
Qiskit Dynamics may be installed using pip via:
pip install qiskit-dynamics
Additionally, Qiskit Dynamics may be installed simultaneously with the CPU version of JAX via:
pip install "qiskit-dynamics[jax]"
Installing JAX with GPU support must be done manually, for instructions refer to the JAX installation guide.
Contribution Guidelines
If you'd like to contribute to Qiskit Dynamics, please take a look at our contribution guidelines. This project adheres to Qiskit's code of conduct. By participating, you are expected to uphold this code.
We use GitHub issues for tracking requests and bugs. Please join the Qiskit Slack community and use our #qiskit-dynamics channel for discussion and simple questions. For questions that are more suited for a forum we use the Qiskit tag in the Stack Exchange.
Authors and Citation
Qiskit Dynamics is the work of many people who contribute to the project at different levels. If you use Qiskit Dynamics, please cite our paper as per the included BibTeX file.
License
Owner
- Name: Qiskit Community
- Login: qiskit-community
- Kind: organization
- Website: https://community.qiskit.org
- Repositories: 71
- Profile: https://github.com/qiskit-community
Citation (CITATION.bib)
@article{qiskit_dynamics_2023,
title = {Qiskit {Dynamics}: {A} {Python} package for simulating the time dynamics of quantum systems},
volume = {8},
issn = {2475-9066},
url = {https://joss.theoj.org/papers/10.21105/joss.05853},
doi = {10.21105/joss.05853},
number = {90},
journal = {Journal of Open Source Software},
author = {Puzzuoli, Daniel and Wood, Christopher J. and Egger, Daniel J. and Rosand, Benjamin and Ueda, Kento},
year = {2023},
pages = {5853}
}
GitHub Events
Total
- Issues event: 16
- Watch event: 9
- Issue comment event: 27
- Push event: 13
- Pull request review comment event: 2
- Pull request review event: 9
- Pull request event: 29
- Fork event: 3
Last Year
- Issues event: 16
- Watch event: 9
- Issue comment event: 27
- Push event: 13
- Pull request review comment event: 2
- Pull request review event: 9
- Pull request event: 29
- Fork event: 3
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Daniel Puzzuoli | d****i@g****m | 167 |
| CHRISTOPHER J WOOD | c****d@u****m | 17 |
| Kento Ueda | 3****o | 16 |
| Daniel Egger | d****g@z****m | 16 |
| Matthew Treinish | m****h@k****g | 8 |
| brosand | b****d@i****m | 7 |
| Ian Hincks | i****s@i****m | 5 |
| R K Rupesh | 3****n | 4 |
| vvilpas | v****s@g****m | 4 |
| averyparr | 6****r | 3 |
| Luciano Bello | b****l@z****m | 3 |
| Eric Arellano | 1****o | 3 |
| donsano33 | 7****3 | 2 |
| Will Shanks | w****s@u****m | 2 |
| Arthur Strauss | 5****s | 2 |
| Arnau Casau | 4****u | 2 |
| dekelmeirom | 3****m | 1 |
| brosand | b****d@g****m | 1 |
| Moein Malekakhlagh | 5****h | 1 |
| Junye Huang | h****e@g****m | 1 |
| Jake Lishman | j****e@b****m | 1 |
| Ivana | i****o@g****m | 1 |
| Inho Choi | 7****o | 1 |
| Haggai Landa | 5****a | 1 |
| Eli Arbel | 4****l | 1 |
| Divyanshu Singh | 5****r | 1 |
| Daniel Puzzuoli | d****i@D****l | 1 |
| Ashish Panigrahi | a****i@p****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 26
- Total pull requests: 110
- Average time to close issues: 7 months
- Average time to close pull requests: 10 days
- Total issue authors: 9
- Total pull request authors: 13
- Average comments per issue: 1.27
- Average comments per pull request: 0.66
- Merged pull requests: 89
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 10
- Pull requests: 39
- Average time to close issues: 24 days
- Average time to close pull requests: 18 days
- Issue authors: 3
- Pull request authors: 7
- Average comments per issue: 0.4
- Average comments per pull request: 0.67
- Merged pull requests: 25
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- DanPuzzuoli (9)
- xyzdxf (1)
- hodgestar (1)
- wshanks (1)
- rupeshknn (1)
- TilmannRS (1)
Pull Request Authors
- DanPuzzuoli (77)
- to24toro (9)
- arthurostrauss (5)
- wshanks (4)
- arnaucasau (3)
- rupeshknn (2)
- Naohnakazawa (2)
- IvanaGyro (2)
- donsano33 (2)
- Eric-Arellano (1)
- jakelishman (1)
- 1ucian0 (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- astroid ==2.9.3
- black *
- ddt *
- jupyter-sphinx *
- matplotlib >=3.3.0
- nbsphinx *
- pygments >=2.4
- pylint ==2.12.2
- qiskit-sphinx-theme >=1.6
- qutip *
- reno >=3.4.0
- sphinx-autodoc-typehints *
- stestr >=3.0.0
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite