https://github.com/cqcl/peropq

Perturbative Optimization for Hamiltonian Simulation

https://github.com/cqcl/peropq

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords from Contributors

archival projection profiles interactive sequences generic observability autograding hacking shellcodes
Last synced: 11 months ago · JSON representation

Repository

Perturbative Optimization for Hamiltonian Simulation

Basic Info
  • Host: GitHub
  • Owner: CQCL
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 81.1 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 7
  • Releases: 3
Created almost 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

PerOpQ

Read the Docs

PerOpQ is an implementation of Perturbative Optimization for Hamiltonian Simulation, based on the ideas presented in arXiv:2306.07208. The goal of the library is to provide optimized circuits to perform Hamiltonian simulations with less error than with naive Trotter decompositions. The basic idea is to evaluate the error of an ansatz unitary (decomposed into a set of one-qubit and two-qubit gates) by applying recursively the Baker–Campbell–Hausdorff (BCH) formula and truncating the resulting series at a given order. PerOpQ takes a model defined by a list of Pauli strings, a final time and a circuit depth as inputs and returns an optimized circuit as a result.

Development

This project uses Poetry for packaging and dependency management and Nox for task automation.

Recommended development setup

It is recommended to do these steps in a fresh python virtual environment

Install development tools:

shell pip install -r dev-tool-requirements.txt

Local development with Nox (recommended)

Nox can be used to automate various development tasks running in isolated python environments. The following Nox sessions are provided:

  • pre-commit: run the configured pre-commit hooks within .pre-commit-config.yaml, this includes linting with black and pylint
  • mypy: run type checks using mypy
  • tests: run the unit tests
  • docs-build: build the documentation

To run a session use:

shell nox -s <session_name>

To save time, reuse the session virtual environment using the -r option, i.e. nox -rs <session_name> (may cause errors after a dependency update).

Pre-commit can be used to run the pre-commit hooks before each commit. This is recommended. To set up the pre-commit hooks to run automatically on each commit run:

shell nox -s pre-commit -- install

Afterward, the pre-configured hooks will run on all changed files in a commit and the commit will be rejected if the hooks find errors. Some hooks will correct formatting issues automatically (but will still reject the commit, so that the git commit command will need to be repeated).

Owner

  • Name: Cambridge Quantum
  • Login: CQCL
  • Kind: organization
  • Location: Cambridge, UK

Quantum Software and Technologies

GitHub Events

Total
  • Watch event: 1
  • Fork event: 2
Last Year
  • Watch event: 1
  • Fork event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 39
  • Total Committers: 3
  • Avg Commits per committer: 13.0
  • Development Distribution Score (DDS): 0.462
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Travis Thompson 1****o 21
dependabot[bot] 4****] 13
KevinHemery 1****2 5

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 6
  • Total pull requests: 44
  • Average time to close issues: 3 days
  • Average time to close pull requests: 9 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.25
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 26
Past Year
  • Issues: 6
  • Pull requests: 7
  • Average time to close issues: 3 days
  • Average time to close pull requests: 7 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.57
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 5
Top Authors
Issue Authors
  • trvto (3)
Pull Request Authors
  • dependabot[bot] (23)
  • trvto (17)
  • stochastic2 (6)
Top Labels
Issue Labels
Pull Request Labels
dependencies (23) python (16) github_actions (7)

Dependencies

.github/workflows/nox-session.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5.0.0 composite
  • actions/upload-artifact v4 composite
.github/workflows/release.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5.0.0 composite
  • pypa/gh-action-pypi-publish v1.8.11 composite
  • release-drafter/release-drafter v6.0.0 composite
  • salsify/action-detect-and-tag-new-version v2.0.3 composite
.github/workflows/tests.yml actions
dev-tool-requirements.txt pypi
  • nox >=2023.4.22 development
  • poetry >=1.6.1 development
docs/requirements.txt pypi
  • furo *
  • myst-parser *
  • sphinx *
  • sphinx-autodoc-typehints *
pyproject.toml pypi
  • coverage >=6.1,<8.0 coverage
  • furo ^2024.1.29 docs
  • myst-parser ^2.0.0 docs
  • sphinx ^7.2.6 docs
  • sphinx-autodoc-typehints ^1.22 docs
  • mypy ^1.6.0 mypy
  • black >=22.3 pre-commit
  • darglint ^1.8.1 pre-commit
  • pre-commit >=2.15,<4.0 pre-commit
  • pyupgrade >=2.29,<4.0 pre-commit
  • ruff ^0.2.1 pre-commit
  • numpy ~1.26
  • python >=3.10,<4.0
  • scipy ^1.11.3
  • pytest ^8.0.0 tests
.github/workflows/release-drafter.yml actions
  • release-drafter/release-drafter v6.0.0 composite