Logo
qci-client v4.4.0
  • Getting Started
  • Basic Usage
    • Instantiating a Client for Optimization Work
      • Without Environment Variables
      • With Environment Variables
  • qci-client
    • qci_client
      • qci_client
        • JobStatus
        • QciClient
      • qci_client.utilities
        • raise_for_status()
        • log_to_console()
        • now_utc_ms()
    • qci_client.auth
      • qci_client.auth
      • qci_client.auth.client
        • AuthClient
    • qci_client.optimization
      • qci_client.optimization
      • qci_client.optimization.client
        • OptimizationClient
      • qci_client.optimization.data_converter
        • data_to_json()
      • qci_client.optimization.enum
        • JobType
        • ProblemType
        • DeviceType
        • JobStatus
        • FileType
        • get_file_type()
      • qci_client.optimization.utilities
        • get_file_type()
        • get_file_config()
        • get_post_request_body()
        • get_patch_request_body()
        • zip_payload()
        • file_part_generator()
  • Dependencies
    • Packages
    • Semantic Versioning Policy
  • Index
  • Module Index
qci-client
  • Getting Started
  • View page source

Getting Started

Introduction

qci-client is a Python package that contains clients for various QCi applications accessed via QCi’s Qatalyst REST API. These client subpackages include qci_client.auth for v1 authentication applications such as—

  • https://api.qci-prod.com/auth/v1/access-tokens/version

and qci_client.optimization for v1 optimization applications such as—

  • https://api.qci-prod.com/optimization/v1/files/version

  • https://api.qci-prod.com/optimization/v1/jobs/version

Installation

Install the latest qci-client from the public PyPI server into a Python virtual environment using—

pip install --upgrade qci-client

Table of Contents

  • Getting Started
  • Basic Usage
    • Instantiating a Client for Optimization Work
      • Without Environment Variables
      • With Environment Variables
  • qci-client
    • qci_client
      • qci_client
      • qci_client.utilities
    • qci_client.auth
      • qci_client.auth
      • qci_client.auth.client
    • qci_client.optimization
      • qci_client.optimization
      • qci_client.optimization.client
      • qci_client.optimization.data_converter
      • qci_client.optimization.enum
      • qci_client.optimization.utilities
  • Dependencies
    • Packages
    • Semantic Versioning Policy
  • Index
  • Module Index
Next

© Copyright 2023-2024 Quantum Computing Inc. All rights reserved.

Built with Sphinx using a theme provided by Read the Docs.