Data

Tools

Indexes

Applications

Experiments

Open Source Science

quantumcollocation.jl

Quantum Optimal Control with Direct Collocation

https://github.com/harmoniqs/quantumcollocation.jl

Science Score: 64.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
  • ✓
    Academic publication links
    Links to: arxiv.org
  • ✓
    Committers with academic emails
    3 of 12 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.9%) to scientific vocabulary

Keywords

direct-collocation julia optimal-control optimization quantum-computing quantum-optimal-control trajectory-optimization
Last synced: 4 months ago · JSON representation ·

Repository

Quantum Optimal Control with Direct Collocation

Basic Info
  • Host: GitHub
  • Owner: harmoniqs
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Homepage:
  • Size: 96.7 MB
Statistics
  • Stars: 35
  • Watchers: 5
  • Forks: 15
  • Open Issues: 27
  • Releases: 17
Topics
direct-collocation julia optimal-control optimization quantum-computing quantum-optimal-control trajectory-optimization
Created almost 3 years ago · Last pushed 5 months ago
Metadata Files
Readme License Citation

README.md

Piccolo.jl
Documentation
Stable Dev arXiv 		Build Status
Build Status Coverage 		License
MIT License 		Support
Unitary Fund
Quickly set up and solve problem templates for quantum optimal control

QuantumCollocation.jl

QuantumCollocation.jl sets up and solves quantum control problems as nonlinear programs (NLPs). In this context, a generic quantum control problem looks like math \begin{aligned} \arg \min_{\mathbf{Z}}\quad & J(\mathbf{Z}) \\ \nonumber \text{s.t.}\qquad & \mathbf{f}(\mathbf{Z}) = 0 \\ \nonumber & \mathbf{g}(\mathbf{Z}) \le 0 \end{aligned} where $\mathbf{Z}$ is a trajectory containing states and controls, from NamedTrajectories.jl.

For details of our implementation please see our IEEE QCE 2023 paper, Direct Collocation for Quantum Optimal Control. If you use QuantumCollocation.jl in your work, please cite :raised_hands:!

Installation

This package is registered! To install, enter the Julia REPL, type ] to enter pkg mode, and then run: julia pkg> add QuantumCollocation

Example

Single Qubit Hadamard Gate

```Julia using QuantumCollocation

T = 50 Δt = 0.2 system = QuantumSystem([PAULIS[:X], PAULIS[:Y]]) U_goal = GATES.H

Hadamard Gate

prob = UnitarySmoothPulseProblem(system, Ugoal, T, Δt) solve!(prob, maxiter=100) ```

Building Documentation

This package uses a Documenter config that is shared with many of our other repositories. To build the docs, you will need to run the docs setup script to clone and pull down the utility. ```

first time only

./docs/getdocsutils.sh # or ./getdocsutils.sh if cwd is in ./docs/ ```

To build the docs pages: julia --project=docs docs/make.jl

or editing the docs live: ``` julia --project=docs

using LiveServer, QuantumCollocation, Revise servedocs(literatedir="docs/literate", skipdirs=["docs/src/generated"]) ```

Note: servedocs needs to watch a subset of the files in the docs/ folder. If it watches files that are generated on a docs build/re-build, servedocs will continuously try to re-serve the pages.

To prevent this, ensure all generated files are included in the skip dirs or skip files args for servedocs.

For example, if we forget docs/src/generated like so: ``` julia --project=docs

using LiveServer, Piccolo, Revise servedocs(literate_dir="docs/literate") ``` it will not build and serve.

Owner

  • Name: harmoniqs
  • Login: harmoniqs
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Trowbridge"
  given-names: "Aaron"
- family-names: "Bhardwaj"
  given-names: "Aditya"
title: "QuantumCollocation.jl"
version: 0.1.2
date-released: 2023-02-09
url: "https://github.com/aarontrowbridge/QuantumCollocation.jl"

GitHub Events

Total
  • Create event: 21
  • Commit comment event: 13
  • Release event: 2
  • Issues event: 21
  • Watch event: 1
  • Delete event: 4
  • Issue comment event: 36
  • Push event: 101
  • Pull request review event: 12
  • Pull request review comment event: 7
  • Pull request event: 30
  • Fork event: 4
Last Year
  • Create event: 21
  • Commit comment event: 13
  • Release event: 2
  • Issues event: 21
  • Watch event: 1
  • Delete event: 4
  • Issue comment event: 36
  • Push event: 101
  • Pull request review event: 12
  • Pull request review comment event: 7
  • Pull request event: 30
  • Fork event: 4

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 759
  • Total Committers: 12
  • Avg Commits per committer: 63.25
  • Development Distribution Score (DDS): 0.58
Past Year
  • Commits: 197
  • Committers: 7
  • Avg Commits per committer: 28.143
  • Development Distribution Score (DDS): 0.563
Top Committers
Name Email Commits
Aaron Trowbridge a****e@g****m 319
andy a****1@g****m 215
repo-visualizer r****r 86
a7b a****2@g****m 69
Jack Champagne j****g@a****u 21
maxwell04 m****4@g****m 10
Hong-Ye Hu h****s@g****m 9
CompatHelper Julia c****y@j****g 9
Fe-r-oz f****f@g****m 7
Martin Klacan m****n@s****l 6
bbhattacharyya1729 b****c@c****u 4
Andy Goldschmidt a****1@g****m 4
Committer Domains (Top 20 + Academic)
caltech.edu: 1 student.vu.nl: 1 julialang.org: 1 andrew.cmu.edu: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 24
  • Total pull requests: 84
  • Average time to close issues: 6 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 6
  • Total pull request authors: 10
  • Average comments per issue: 0.92
  • Average comments per pull request: 0.7
  • Merged pull requests: 51
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 9
  • Pull requests: 57
  • Average time to close issues: 4 months
  • Average time to close pull requests: 6 days
  • Issue authors: 4
  • Pull request authors: 8
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.67
  • Merged pull requests: 39
  • Bot issues: 0
  • Bot pull requests: 6
View more stats
Top Authors
Issue Authors
  • andgoldschmidt (13)
  • aarontrowbridge (6)
  • Fe-r-oz (1)
  • amcclaingomez3 (1)
  • jack-champagne (1)
  • hongyehu (1)
Pull Request Authors
  • andgoldschmidt (26)
  • github-actions[bot] (16)
  • aarontrowbridge (15)
  • jack-champagne (12)
  • martin-klacan (4)
  • Fe-r-oz (4)
  • gennadiryan (3)
  • BBhattacharyya1729 (2)
  • maxwell04-wq (1)
  • Silas-Coleman (1)
Top Labels
Issue Labels
enhancement (17) bug (6) good first issue (3) help wanted (1)
Pull Request Labels

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v2 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-docdeploy v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/diagram.yml actions
  • actions/checkout master composite
  • actions/download-artifact v2 composite
  • githubocto/repo-visualizer main composite
.github/workflows/documentation.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/CompatHelper.yml actions