qugrad

A Python package for quantum optimal control.

https://github.com/christopher-k-long/qugrad

Science Score: 44.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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary

Keywords

control optimal quantum
Last synced: 6 months ago · JSON representation ·

Repository

A Python package for quantum optimal control.

Basic Info
  • Host: GitHub
  • Owner: Christopher-K-Long
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://QuGrad.readthedocs.io
  • Size: 47.9 KB
Statistics
  • Stars: 5
  • Watchers: 0
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Topics
control optimal quantum
Created 8 months ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License Citation

README.md

QuGrad

A Python package for quantum optimal control.

Unit Tests

Installation

The python package can be installed with pip as follows: bash pip install qugrad

If on Linux and using a conda environment you may encounter an error version `GLIBCXX_...' not found to fix this you also need to execute: bash conda install -c conda-forge libstdcxx-ng

Requirements

Requires: - PySTE - TensorFlow - NumPy

Additional requirements for testing

Documentation

Documentation including worked examples can be found at: https://QuGrad.readthedocs.io

Source Code

Source code can be found at: https://github.com/Christopher-K-Long/QuGrad

Version and Changes

The current version is 1.0.1. Please see the Change Log for more details. QuGrad uses semantic versioning.

Owner

  • Name: Christopher K. Long
  • Login: Christopher-K-Long
  • Kind: user
  • Company: The University of Cambridge

PhD candidate at the University of Cambridge working on quantum algorithms.

Citation (CITATION.cff)

cff-version: 1.2.0
title: QuGrad
message: >-
  If you use Suzuki-Trotter-Evolver please cite the accompanying paper:

    Long, C. K., Mayhall, N. J., Economou, S. E., Barnes, E., Barnes, C. H. W.,
    Martins, F., … Mertig, N. (2024). Minimal evolution times for fast,
    pulse-based state preparation in silicon spin qubits. arXiv [Quant-Ph].
    Retrieved from http://arxiv.org/abs/2406.10913

  Additionally, you can reference this code base using this CFF file.
type: software
authors:
  - given-names: Christopher K.
    family-names: Long
    email: ckl45@cam.ac.uk
    affiliation: University of Cambridge and Hitachi Cambridge Laboratory
    orcid: 'https://orcid.org/0009-0001-3230-942X'
  - given-names: Crispin H. W.
    family-names: Barnes
    affiliation: University of Cambridge
    orcid: 'https://orcid.org/0000-0001-7337-7245'
  - given-names: Normann
    family-names: Metrig
    affiliation: Hitachi Cambridge Laboratory
    orcid: 'https://orcid.org/0000-0003-3025-7141'
repository-code: 'https://github.com/Christopher-K-Long/QuGrad'
url: 'https://github.com/Christopher-K-Long/QuGrad'
abstract: A Python package for quantum optimal control.
keywords:
  - quantum
  - optimal
  - control
license: Apache-2.0
version: 1.0.1
date-released: '2025-06-16'

GitHub Events

Total
  • Watch event: 1
  • Push event: 6
  • Fork event: 1
Last Year
  • Watch event: 1
  • Push event: 6
  • Fork event: 1

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 48 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 4
  • Total maintainers: 1
pypi.org: qugrad

A Python package for quantum optimal control.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 24 Last month
Rankings
Dependent packages count: 9.0%
Average: 29.8%
Dependent repos count: 50.6%
Maintainers (1)
Last synced: 6 months ago
pypi.org: qugradlab

An extension to the Python package QuGrad that implements common Hilbert space structures, Hamiltonians, and pulse shapes for quantum control.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 24 Last month
Rankings
Dependent packages count: 9.0%
Average: 29.8%
Dependent repos count: 50.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/publish-to-pypi-and-release.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • sigstore/gh-action-sigstore-python v3.0.0 composite
.github/workflows/publish-to-test-pypi.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/test-python-package.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
docs/requirements.txt pypi
  • cffconvert *
  • furo *
  • myst-parser *
  • sphinx-codeautolink *
  • sphinx_math_dollar *
  • sphinx_tabs *
pyproject.toml pypi
  • numpy *
  • py-ste *
  • tensorflow *
requirements.txt pypi
tests/requirements.txt pypi
  • pytest * test
  • pyyaml * test
  • toml * test