QAOA.jl
QAOA.jl: Toolkit for the Quantum and Mean-Field Approximate Optimization Algorithms - Published in JOSS (2023)
Science Score: 100.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 12 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: arxiv.org, aps.org, joss.theoj.org, zenodo.org -
✓Committers with academic emails
1 of 9 committers (11.1%) from academic institutions -
✓Institutional organization owner
Organization fzj-pgi-12 has institutional domain (www.fz-juelich.de) -
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
Basic Info
- Host: GitHub
- Owner: FZJ-PGI-12
- License: apache-2.0
- Language: Julia
- Default Branch: master
- Size: 1.75 MB
Statistics
- Stars: 14
- Watchers: 1
- Forks: 6
- Open Issues: 1
- Releases: 11
Metadata Files
README.md
QAOA.jl
This package implements the Quantum Approximate Optimization Algorithm and the Mean-Field Approximate Optimization Algorithm.
Installation
To install, use Julia's built-in package manager
julia
julia> ] add QAOA
Documentation & Examples
Our docs can be found here. Examples showcasing the use of QAOA.jl are also presented in our examples folder.
Benchmarks
QAOA.jl also supports gradient optimization via automatic differentiation. Below is a comparison of run times between PennyLane [@PennyLane] and QAOA.jl on an Apple M1 processor. The benchmarks are retrieved by performing 128 steps with the respective gradient optimizer on the same instance of size $N$ of the minimum vertex-cover problem.

Support & Contributing
In case you need support or have encountered a problem with the package, you are welcome to create an issue on GitHub. If you would like to contribute to QAOA.jl, you can reach us via PGI-12.
Citations
If you are using code from this repository, please cite our work. Also consider our algorithmic paper:
@article{PRXQuantum.4.030335,
title = {Mean-Field Approximate Optimization Algorithm},
author = {Misra-Spieldenner, Aditi and Bode, Tim and Schuhmacher, Peter K. and Stollenwerk, Tobias and Bagrets, Dmitry and Wilhelm, Frank K.},
journal = {PRX Quantum},
volume = {4},
issue = {3},
pages = {030335},
numpages = {19},
year = {2023},
month = {Sep},
publisher = {American Physical Society},
doi = {10.1103/PRXQuantum.4.030335},
url = {https://link.aps.org/doi/10.1103/PRXQuantum.4.030335}
}
Owner
- Name: FZJ-PGI-12
- Login: FZJ-PGI-12
- Kind: organization
- Website: https://www.fz-juelich.de/en/pgi/pgi-12
- Repositories: 1
- Profile: https://github.com/FZJ-PGI-12
Quantum Computing Analytics, Peter-Grünberg-Institut 12, Forschungszentrum Jülich
JOSS Publication
QAOA.jl: Toolkit for the Quantum and Mean-Field Approximate Optimization Algorithms
Authors
Institute for Quantum Computing Analytics (PGI-12), Forschungszentrum Jülich, 52425 Jülich, Germany
Institute for Quantum Computing Analytics (PGI-12), Forschungszentrum Jülich, 52425 Jülich, Germany, Institute for Theoretical Physics, University of Cologne, 50937 Cologne, Germany
Theoretical Physics, Saarland University, 66123 Saarbrücken, Germany
Institute for Quantum Computing Analytics (PGI-12), Forschungszentrum Jülich, 52425 Jülich, Germany
Institute for Quantum Computing Analytics (PGI-12), Forschungszentrum Jülich, 52425 Jülich, Germany, Theoretical Physics, Saarland University, 66123 Saarbrücken, Germany
Tags
quantum algorithms automatic differentiation optimizationCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Bode
given-names: Tim
orcid: "https://orcid.org/0000-0001-8280-3891"
- family-names: Bagrets
given-names: Dmitry
- family-names: Misra-Spieldenner
given-names: Aditi
- family-names: Stollenwerk
given-names: Tobias
- family-names: Wilhelm
given-names: Frank K.
contact:
- family-names: Bode
given-names: Tim
orcid: "https://orcid.org/0000-0001-8280-3891"
doi: 10.5281/zenodo.8086187
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Bode
given-names: Tim
orcid: "https://orcid.org/0000-0001-8280-3891"
- family-names: Bagrets
given-names: Dmitry
- family-names: Misra-Spieldenner
given-names: Aditi
- family-names: Stollenwerk
given-names: Tobias
- family-names: Wilhelm
given-names: Frank K.
date-published: 2023-06-28
doi: 10.21105/joss.05364
issn: 2475-9066
issue: 86
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5364
title: "QAOA.jl: Toolkit for the Quantum and Mean-Field Approximate
Optimization Algorithms"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05364"
volume: 8
title: "QAOA.jl: Toolkit for the Quantum and Mean-Field Approximate
Optimization Algorithms"
GitHub Events
Total
- Create event: 3
- Commit comment event: 2
- Release event: 1
- Issues event: 5
- Watch event: 1
- Delete event: 2
- Issue comment event: 1
- Push event: 8
- Pull request event: 4
- Fork event: 1
Last Year
- Create event: 3
- Commit comment event: 2
- Release event: 1
- Issues event: 5
- Watch event: 1
- Delete event: 2
- Issue comment event: 1
- Push event: 8
- Pull request event: 4
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| timbode | l****t@p****m | 74 |
| timbode | t****e@T****l | 16 |
| timbode | t****e@t****3 | 6 |
| timbode | t****e@T****l | 4 |
| DrWatson | no@m****l | 3 |
| krish | 4****h | 1 |
| Daniel S. Katz | d****z@i****g | 1 |
| Abinash Satapathy | i****8@g****m | 1 |
| timbode | t****e@t****n | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 33
- Total pull requests: 27
- Average time to close issues: 21 days
- Average time to close pull requests: about 1 hour
- Total issue authors: 5
- Total pull request authors: 4
- Average comments per issue: 0.79
- Average comments per pull request: 0.15
- Merged pull requests: 27
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 2
- Average time to close issues: 29 minutes
- Average time to close pull requests: 9 minutes
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- timbode (29)
- babreu-ncsa (2)
- Abinashbunty (2)
- JuliaTagBot (1)
- krish-rmsh (1)
Pull Request Authors
- timbode (31)
- krish-rmsh (2)
- Abinashbunty (1)
- danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- julia 1 total
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 26
proxy.golang.org: github.com/FZJ-PGI-12/QAOA.jl
- Documentation: https://pkg.go.dev/github.com/FZJ-PGI-12/QAOA.jl#section-documentation
- License: apache-2.0
-
Latest release: v1.3.3
published about 1 year ago
Rankings
proxy.golang.org: github.com/fzj-pgi-12/qaoa.jl
- Documentation: https://pkg.go.dev/github.com/fzj-pgi-12/qaoa.jl#section-documentation
- License: apache-2.0
-
Latest release: v1.3.3
published about 1 year ago
Rankings
juliahub.com: QAOA
- Documentation: https://docs.juliahub.com/General/QAOA/stable/
- License: Apache-2.0
-
Latest release: 1.3.3
published about 1 year ago