Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cqcl/pytket-qujax

https://github.com/cqcl/pytket-qujax

Science Score: 26.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
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: CQCL
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 18 MB
Statistics
  • Stars: 10
  • Watchers: 9
  • Forks: 3
  • Open Issues: 5
  • Releases: 29
Created almost 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Codeowners

README.md

pytket-qujax

Slack Stack Exchange

This repository contains the pytket-qujax extension, using CQC's pytket quantum SDK. The other pytket extensions can be found here

Pytket is a Python module for interfacing with CQC tket, a set of quantum programming tools.

qujax is a pure JAX quantum simulator. pytket-qujax is an extension to pytket that allows pytket circuits to be converted to qujax for fast (classical) simulation and automatic differentiation.

Some useful links: - Documentation - PyPI - qujax - pytket-qujax example notebook (VQE) - pytket-qujax example notebook (QAOA with symbol_map) - pytket-qujax example notebook (classifier) - qujax example notebooks

Getting started

pytket-qujax is available for Python 3.10, 3.11 and 3.12, on Linux and MacOS. To install, run:

shell pip install pytket-qujax

This will install pytket if it isn't already installed, and add new classes and methods into the pytket.extensions namespace.

Bugs and feature requests

Please file bugs and feature requests on the Github issue tracker.

Development

To install an extension in editable mode, simply change to its subdirectory within the modules directory, and run:

shell pip install -e .

Contributing

Pull requests are welcome. To make a PR, first fork the repo, make your proposed changes on the main branch, and open a PR from your fork. If it passes tests and is accepted after review, it will be merged in.

Code style

Formatting

All code should be formatted using black, with default options. This is checked on the CI. The CI is currently using version 20.8b1.

Type annotation

On the CI, mypy is used as a static type checker and all submissions must pass its checks. You should therefore run mypy locally on any changed files before submitting a PR. Because of the way extension modules embed themselves into the pytket namespace this is a little complicated, but it should be sufficient to run the script modules/mypy-check (passing as a single argument the root directory of the module to test). The script requires mypy 0.800 or above.

Linting

We use pylint on the CI to check compliance with a set of style requirements (listed in .pylintrc). You should run pylint over any changed files before submitting a PR, to catch any issues.

Tests

To run the tests for a module:

  1. cd into that module's tests directory;
  2. ensure you have installed pytest, hypothesis, and any modules listed in the test-requirements.txt file (all via pip);
  3. run pytest.

When adding a new feature, please add a test for it. When fixing a bug, please add a test that demonstrates the fix.

Owner

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

Quantum Software and Technologies

GitHub Events

Total
  • Issues event: 1
  • Watch event: 2
  • Delete event: 10
  • Issue comment event: 3
  • Push event: 19
  • Pull request review comment event: 4
  • Pull request review event: 11
  • Pull request event: 22
  • Fork event: 1
  • Create event: 17
Last Year
  • Issues event: 1
  • Watch event: 2
  • Delete event: 10
  • Issue comment event: 3
  • Push event: 19
  • Pull request review comment event: 4
  • Pull request review event: 11
  • Pull request event: 22
  • Fork event: 1
  • Create event: 17

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 56
  • Total Committers: 5
  • Avg Commits per committer: 11.2
  • Development Distribution Score (DDS): 0.643
Top Committers
Name Email Commits
melf c****c@m****e 20
cqc-melf 7****f@u****m 19
SamDuffield 3****d@u****m 15
Kirill Plekhanov p****l@g****m 1
CalMacCQ 9****Q@u****m 1
Committer Domains (Top 20 + Academic)
melf.de: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 14
  • Total pull requests: 146
  • Average time to close issues: 9 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 3
  • Total pull request authors: 9
  • Average comments per issue: 0.86
  • Average comments per pull request: 0.17
  • Merged pull requests: 133
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 1
  • Pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: 22 days
  • Issue authors: 1
  • Pull request authors: 5
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.17
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 5
View more stats
Top Authors
Issue Authors
  • SamDuffield (8)
  • cqc-melf (5)
  • gamatos (1)
Pull Request Authors
  • cqc-melf (117)
  • dependabot[bot] (22)
  • SamDuffield (18)
  • cqc-alec (9)
  • gamatos (4)
  • CalMacCQ (3)
  • sjdilkes (2)
  • willsimmons1465 (1)
  • kplekhanov (1)
Top Labels
Issue Labels
enhancement (4) documentation (1) good first issue (1) bug (1) wontfix (1)
Pull Request Labels
dependencies (22) github_actions (12) python (7)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,296 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 29
  • Total maintainers: 2
pypi.org: pytket-qujax

Extension for pytket, providing access to qujax functions

  • Versions: 29
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 1,296 Last month
Rankings
Dependent packages count: 10.0%
Downloads: 11.2%
Average: 17.4%
Stargazers count: 21.5%
Dependent repos count: 21.7%
Forks count: 22.6%
Maintainers (2)
cqc-alec cqc-melf
Last synced: 11 months ago

Dependencies

.github/workflows/docs/requirements.txt pypi
  • sphinx *
  • sphinx_rtd_theme *
setup.py pypi
  • pytket *
  • qujax *
tests/test-requirements.txt pypi
  • hypothesis * test
  • pytest * test
  • pytest-timeout * test
  • requests_mock * test
.github/workflows/build_and_test.yml actions
  • actions/checkout v3 composite
  • actions/deploy-pages v1 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • actions/upload-pages-artifact v1 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite