qci-client 5.0.0

Client Package for using Qatalyst Optimization Suite

QCI Client

Getting started

Installation

qci-client currently supports Python 3.9-13, inclusive, as specified in the PEP-621-compliant pyproject.toml file.

Install qci-client from the public PyPI server into your Python virtual environment using--

pip install qci-client

Instantiating a Client for Optimization

With Environment Variables

To access the API, set these environment variables--

• QCI_API_URL - URL for Qatalyst API, Example: "https://api.qci-prod.com"
• QCI_TOKEN - refresh token string for securely accessing Qatalyst API

then instantiate a QciClient as follows--

# An alias for `from qci_client.optimization.client import Client as QciClient`.
from qci_client import QciClient

client = QciClient()

Without Environment Variables

Access the API without first defining environment variables by instantiating a QciClient as follows--

# A alias for `from qci_client.optimization.client import Client as QciClient`.
from qci_client import QciClient

client = QciClient(url="https://api.qci-prod.com", api_token="<secret-token>")