Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cqcl/qnexus

Python client for the Quantinuum Nexus Quantum Computing Platform

https://github.com/cqcl/qnexus

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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

guppy hugr pytket qir quantinuum quantum-computing wasm
Last synced: 5 months ago · JSON representation

Repository

Python client for the Quantinuum Nexus Quantum Computing Platform

Basic Info
Statistics
  • Stars: 16
  • Watchers: 1
  • Forks: 3
  • Open Issues: 20
  • Releases: 43
Topics
guppy hugr pytket qir quantinuum quantum-computing wasm
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Codeowners

README.md

qnexus

pypi py-version

A python client for the Quantinuum Nexus platform.

```python import qnexus as qnx

Will open a browser window to login with Nexus credentials

qnx.login()

Dataframe representation of all your pending jobs in Nexus

qnx.jobs.getall(jobstatus=["SUBMITTED", "QUEUED", "RUNNING"]).df() ```

Install

qnexus can be installed via pip.

sh pip install qnexus

Usage

Usage examples and tutorials are available here.

Development

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

The easiest way to setup the development environment is to use the provided devenv.nix file. This will setup a development shell with all the required dependencies.

To use this, you will need to install devenv. Once you have it running, open a shell with:

bash devenv shell

Specifically the project relies on these tools:

Installation for development

By default devenv will set up your uv virtual environment. If you aren't using devenv please check the uv documentation for creating and using a virtual environment.

You can then install all dependencies with:

sh uv sync

To run a single command in the shell, just prefix it with uv run.

Checks

Formatting, linting and type-checking are added as a devenv script and can be run with:

sh qfmt

Testing

Most of the test suite are integration tests that require the following environment variables:

sh NEXUS_DOMAIN = "qa.myqos.com" NEXUS_QA_USER_EMAIL = "qa_nexus_staging_pytket-nexus@mailsac.com" NEXUS_QA_USER_PASSWORD = <copy from Bitwarden 'qnexus integration tests user'> NEXUS_QA_QSYS_DEVICE = "H1-1E"

And can be run locally (for the above user) with:

```sh uv run python integration/setup_tokens.py

uv run pytest integration/ ```

These will only be available to run via Github CI by internal team members. For external contributions we recommend writing unit tests and/or integration tests and requesting they be run by an internal reviewer.

Unit tests can be run with:

sh uv run scripts/run_unit_tests.sh

or to run via devenv script:

sh qtest

As some auth tests these manipulate environment variables they are currently run in isolation via the script.

Release

Step 1 - update the changelog

  • Update CHANGELOG.md: this is automated. Use devenv and the commitizen tool: git fetch --tags origin # make sure your local tags are same as in github cz bump --files-only # --files-only prevents the tool making a git tag This will use the commit history and modify CHANGELOG.md to include a heading with the new version number and the date. It also updates .cz.toml. The tool automatically decides whether to increment the patch version, minor version or major version (major version changes are currently disabled in its config file). It also updates the version in pyproject.toml at the same time.
  • If you like, you can manually edit CHANGELOG.md at this point. Consider moving important entries under these headings, or writing under them (see Keep A Changelog):
    • Deprecated
    • Removed
    • Security
  • Create a release branch git checkout -b release/vx.y.z
  • git add the modifications, then git commit and git push them.
  • Create a PR (title: docs: Update CHANGELOG for vx.y.z)
  • Ask a colleague to review the changes (should be just CHANGELOG.md, pyproject.toml and .cz.toml)
  • Squash merge the PR into main

Step 2 - run the release workflow

  • Go to https://github.com/CQCL-DEV/qnexus/releases/new
  • Select create new tag... on publish when choosing the tag, with name in the format vx.y.z.
  • Choose the target branch/commit for the release (normally main)
  • Put the version number in the "release title" box
  • Copy/paste the new sections from CHANGELOG.md into the "Describe this release" box
  • Click "Publish release"

License

This project is licensed under Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0).

Copyright 2025 Quantinuum Ltd.

Owner

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

Quantum Software and Technologies

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 38
  • Total pull requests: 281
  • Average time to close issues: 3 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 4
  • Total pull request authors: 15
  • Average comments per issue: 0.42
  • Average comments per pull request: 1.02
  • Merged pull requests: 223
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 12
  • Pull requests: 221
  • Average time to close issues: 3 months
  • Average time to close pull requests: 4 days
  • Issue authors: 4
  • Pull request authors: 13
  • Average comments per issue: 0.33
  • Average comments per pull request: 1.19
  • Merged pull requests: 174
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • vanyae-cqc (32)
  • vardhini-quantinuum (3)
  • aidanCQ (2)
  • atlytle (1)
Pull Request Authors
  • vanyae-cqc (128)
  • johnchildren (34)
  • Ariana-Hlavaty (23)
  • quantinuum-richard-morrison (23)
  • aidanCQ (16)
  • qfreewilll (14)
  • chesterwringe (13)
  • ferbetanzo (9)
  • swhiteCQC (9)
  • sp-q (4)
  • aborgna-q (2)
  • ss2165 (2)
  • isobelhooper (2)
  • vardhini-quantinuum (1)
  • CQargi (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 8,069 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 43
  • Total maintainers: 1
pypi.org: qnexus

Quantinuum Nexus python client.

  • Documentation: https://qnexus.readthedocs.io/
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 0.31.0
    published 6 months ago
  • Versions: 43
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 8,069 Last month
Rankings
Dependent packages count: 10.6%
Average: 35.2%
Dependent repos count: 59.7%
Maintainers (1)
quantinuum-nexus
Last synced: 6 months ago