Data

Tools

Indexes

Applications

Experiments

Open Source Science

Piccolo

A Julia package for solving quantum optimal control problems using direct trajectory optimization.

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

Science Score: 54.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
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary

Keywords

direct-collocation iterative-learning-control julia optimization quantum-computing quantum-optimal-control trajectory-optimization

Keywords from Contributors

optimal-control
Last synced: 4 months ago · JSON representation ·

Repository

A Julia package for solving quantum optimal control problems using direct trajectory optimization.

Basic Info
  • Host: GitHub
  • Owner: harmoniqs
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Homepage: https://www.harmoniqs.co
  • Size: 15 MB
Statistics
  • Stars: 44
  • Watchers: 4
  • Forks: 7
  • Open Issues: 8
  • Releases: 11
Topics
direct-collocation iterative-learning-control julia optimization quantum-computing quantum-optimal-control trajectory-optimization
Created over 2 years ago · Last pushed 4 months ago
Metadata Files
Readme License Citation

README.md

Piccolo.jl
Documentation
Stable Dev 		Build Status
Build Status Coverage 		License
MIT License 		Support
Unitary Fund

Description

Piccolo.jl is a meta-package for quantum optimal control using the Pade Integrator Collocation (Piccolo) method. This package reexports the following packages

For documentation please see the individual packages.

Usage

Just run Julia using Piccolo

Installation

This package is registered! To install enter the Julia REPL, type ] to enter pkg mode, activate your environment activate, and then run Julia pkg> add Piccolo

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, Piccolo, Revise servedocs(literatedir="docs/literate", skipdirs=["docs/src/generated", "docs/src/assets/"], skip_files=["docs/src/index.md"]) ```

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 index.md like so: ``` julia --project=docs

using LiveServer, Piccolo, Revise servedocs(literatedir="docs/literate", skipdirs=["docs/src/generated", "docs/src/assets/"]) ``` it will not build and serve.

"Technologies are ways of commandeering nature: the sky belongs to those who know how to fly; the sea belongs to those who know how to swim and navigate." – Simone de Beauvoir

Owner

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

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Piccolo.jl
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Aaron
    family-names: Trowbridge
    email: atrowbri@andrew.cmu
    affiliation: Carnegie Mellon University
  - given-names: Andy
    family-names: Goldschmidt
    email: andygold@uchicago.edu
    affiliation: University of Chicago
  - given-names: Aditya
    family-names: Bhardwaj
    email: a7b@uchicago.edu
    affiliation: University of Chicago
  - given-names: Jack
    family-names: Champagne
    email: jchampag@andrew.cmu.edu
    affiliation: Carnegie Mellon University
repository-code: 'https://github.com/kestrelquantum/Piccolo.jl'
abstract: >-
  A metapackage offering an integrated solution for solving
  quantum optimal control problems using direct collocation.
license: MIT

GitHub Events

Total
  • Create event: 14
  • Commit comment event: 10
  • Issues event: 1
  • Release event: 3
  • Watch event: 9
  • Delete event: 2
  • Issue comment event: 7
  • Push event: 36
  • Pull request review event: 3
  • Pull request review comment event: 4
  • Pull request event: 15
  • Fork event: 2
Last Year
  • Create event: 14
  • Commit comment event: 10
  • Issues event: 1
  • Release event: 3
  • Watch event: 9
  • Delete event: 2
  • Issue comment event: 7
  • Push event: 36
  • Pull request review event: 3
  • Pull request review comment event: 4
  • Pull request event: 15
  • Fork event: 2

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 90
  • Total Committers: 4
  • Avg Commits per committer: 22.5
  • Development Distribution Score (DDS): 0.422
Past Year
  • Commits: 47
  • Committers: 3
  • Avg Commits per committer: 15.667
  • Development Distribution Score (DDS): 0.574
Top Committers
Name Email Commits
Aaron Trowbridge a****e@g****m 52
Jack Champagne j****g@a****u 20
Andy Goldschmidt a****1@g****m 17
Nathan Shammah n****h@g****m 1
Committer Domains (Top 20 + Academic)
andrew.cmu.edu: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 2
  • Total pull requests: 29
  • Average time to close issues: less than a minute
  • Average time to close pull requests: 6 days
  • Total issue authors: 2
  • Total pull request authors: 5
  • Average comments per issue: 5.5
  • Average comments per pull request: 0.24
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 1
  • Pull requests: 26
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.23
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 4
View more stats
Top Authors
Issue Authors
  • Krastanov (1)
  • JuliaTagBot (1)
Pull Request Authors
  • jack-champagne (12)
  • andgoldschmidt (8)
  • github-actions[bot] (4)
  • aarontrowbridge (4)
  • nathanshammah (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • julia 4 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 12
juliahub.com: Piccolo

A Julia package for solving quantum optimal control problems using direct trajectory optimization.

  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 4 Total
Rankings
Dependent repos count: 9.8%
Dependent packages count: 38.0%
Average: 39.2%
Forks count: 54.4%
Stargazers count: 54.4%
Last synced: 4 months ago