# 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