Quick Start

Get QCOS Core running in 5 minutes.

---

Prerequisites

• Python 3.10+
• API Key (get one at https://portal.softquantus.com)

---

Step 1: Install

pip install softqcos

Or with all extras:

pip install softqcos[all]

---

Step 2: Configure

Set your API key:

export QCOS_API_KEY="your-api-key"

Or in Python:

from softqcos import QCOSClient

client = QCOSClient(api_key="your-api-key")

---

Step 3: Run Your First Optimization

Simple Circuit Optimization

from softqcos import QCOSClient

client = QCOSClient()

# Submit a QASM circuit
result = client.optimize(
    qasm='''
    OPENQASM 2.0;
    include "qelib1.inc";
    qreg q[4];
    creg c[4];
    h q[0];
    cx q[0],q[1];
    cx q[1],q[2];
    cx q[2],q[3];
    measure q -> c;
    ''',
    backend="aer_simulator",
    shots=1024
)

print(f"Original depth: {result.original_depth}")
print(f"Optimized depth: {result.optimized_depth}")
print(f"Improvement: {result.improvement_pct}%")
print(f"Evidence ID: {result.evidence_id}")

VQE Optimization

from softqcos import VQEOptimizer
from softqcos.hamiltonians import H2_HAMILTONIAN

optimizer = VQEOptimizer(
    hamiltonian=H2_HAMILTONIAN,
    ansatz="uccsd",
    backend="ionq_simulator"
)

result = optimizer.run(max_iterations=100)

print(f"Ground state energy: {result.energy:.6f} Ha")
print(f"Iterations: {result.iterations}")
print(f"Evaluations saved: {result.evaluations_saved}")

---

Step 4: View Results

Via API

curl https://api.softquantus.com/api/v2/jobs/{job_id} \
  -H "Authorization: Bearer $QCOS_API_KEY"

Via Portal

Visit https://portal.softquantus.com to view:

• Job history
• Optimization metrics
• Evidence bundles
• Usage analytics

---

Step 5: Explore Features

Feature	Command/API	Description
List backends	client.list_backends()	Available quantum backends
Glass-Box	result.glass_box	Optimization transparency
Evidence	result.evidence	Cryptographic proof
Metrics	result.metrics	Performance data

---

Next Steps

• API Reference - Full API documentation
• CLI Reference - Command-line tools
• Python SDK - SDK deep-dive
• Guides - Detailed guides

---

Troubleshooting

API Key Issues

# Verify your API key
softqcos auth verify

Connection Issues

# Check API status
curl https://api.softquantus.com/health

Backend Not Available

# List available backends
backends = client.list_backends()
print(backends)

---

© 2024-2026 SoftQuantus Innovative OÜ