QCloud Client

• Overview
• Setup
  • Requirements
  • Installation
• Usage
• Testing
  • Linting
  • Pytest
• License

Overview

GitHub repository for the Python API wrapper for QCloud, the quantum computing service operated by QPIT at the Technical University of Denmark.

Setup

Requirements

• Python 3.11 or newer
• An account on QCloud

Installation

You can install the package from PyPI:

pip install qcloud-client

To install the latest unreleased code directly from the repository, run:

pip install git+https://github.com/qpit/qcloud-client.git@develop

Usage

The public interface is not yet implemented. Usage examples will be published here alongside the first release that exposes a client.

Import the package using import qcloud_client

Testing

Linting

Code linting checks are performed by the Ruff package. Read more here: https://docs.astral.sh/ruff/

To perform linting checks, run:

ruff check .

The linting rules can be configured in the .ruff.toml file found in the project's root directory with the available rules listed here: https://docs.astral.sh/ruff/rules/

Pytest

To run tests with pytest and generate a coverage report, run:

pytest -v --cov=. --cov-fail-under=85 --cov-report=term-missing:skip-covered

License

Released under the MIT License. See LICENSE for the full text.