Skip to main content

Installation

This guide covers installing the QCOS Python SDK, CLI, and configuring API access.

Note: This site is the public QCOS documentation for customers (SDK/CLI/API + licensing). Internal engineering documentation is maintained separately and is not published here.

System Requirements​

  • Python: 3.9 or higher
  • Operating Systems: Linux, macOS, Windows
  • Dependencies: Automatically installed

Python SDK Installation​

pip install softqcos-sdk

Using Poetry​

poetry add softqcos-sdk

Using Conda​

conda install -c softquantus softqcos-sdk

From Source​

git clone https://github.com/roytmanpiccoli/softqcos_core.git
cd softqcos_core
pip install -e ./softqcos-sdk

If you want to develop the QCOS core library (not the SDK), install from the repo root:

pip install -e ".[dev,test]"

CLI Installation​

The QCOS CLI is included with the SDK but can also be installed separately:

pip install softqcos-cli

Verify installation:

softqcos --version
# QCOS CLI v1.0.0

Optional Dependencies​

Install additional packages for specific features:

# Qiskit integration
pip install softqcos-sdk[qiskit]

# Cirq integration
pip install softqcos-sdk[cirq]

# All integrations
pip install softqcos-sdk[all]

# Development tools
pip install softqcos-sdk[dev]

Docker Installation​

For containerized environments:

docker pull qcosregistry.azurecr.io/softqcos-sdk:latest

docker run -it --rm \
  -e QCOS_API_KEY=your-api-key \
  qcosregistry.azurecr.io/softqcos-sdk:latest \
  python -c "from softqcos_sdk import QCOSClient; print('Ready!')"

Jupyter Notebook​

Install with Jupyter support:

pip install softqcos-sdk[jupyter]

Then in your notebook:

from softqcos_sdk import QCOSClient
from softqcos.visualization import plot_histogram

client = QCOSClient()
result = client.execute(circuit, shots=1024)
plot_histogram(result.counts)

Verifying Installation​

Test SDK​

import softqcos_sdk
print(softqcos_sdk.__version__)

# Test connection
from softqcos_sdk import QCOSClient
client = QCOSClient(api_key="your-api-key")
print(client.health())
# {'status': 'healthy', 'version': '1.0.0'}

Test CLI​

softqcos health
# ✓ API Gateway: healthy
# ✓ Queue Service: connected
# ✓ GPU Workers: 8 available

Environment Variables​

Configure QCOS using environment variables:

# Required
export QCOS_API_KEY="your-api-key"

# Optional
export QCOS_API_URL="https://api.softquantus.com"
export QCOS_TIMEOUT=30
export QCOS_MAX_RETRIES=3
export QCOS_LOG_LEVEL="INFO"

Or use a .env file:

# .env
QCOS_API_KEY=your-api-key
QCOS_API_URL=https://api.softquantus.com

IDE Integration​

VS Code​

Install the QCOS extension for syntax highlighting and autocomplete:

code --install-extension softquantus.softqcos-vscode

PyCharm​

Add QCOS stubs for better autocomplete:

pip install softqcos-stubs

Troubleshooting​

SSL Certificate Errors​

# Update certificates
pip install --upgrade certifi

Connection Timeout​

Check your network and proxy settings:

export HTTPS_PROXY=http://your-proxy:8080

Import Errors​

Ensure you have the correct Python version:

python --version  # Should be 3.9+

Next Steps​