Skip to main content

SoftQCOS™ Quick Start Guide

Installation​

SDK (Python Library)​

pip install softqcos-sdk

CLI (Command Line Interface)​

pip install softqcos

Verify Installation​

# Check versions
softqcos --version

# Expected output:
# SoftQCOS™ CLI version 1.0.0
# QCOS™ SDK version 1.0.0

First Steps​

1. Get Your API Key​

Visit portal.softquantus.com to create an account and obtain your API key.

2. Activate License​

softqcos activate --license-key "QCOS-XXXX-XXXX-XXXX"

3. Run Your First Circuit​

from softqcos_sdk import QCOSClient

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

# Bell State circuit
qasm = """
OPENQASM 2.0;
include "qelib1.inc";
qreg q[2];
creg c[2];
h q[0];
cx q[0], q[1];
measure q -> c;
"""

result = client.execute(qasm=qasm, shots=1024)
print(result.counts)
# Output: {'00': ~512, '11': ~512}

Available SDK Exports​

Client Classes​

  • QCOSClient - Synchronous client
  • AsyncQCOSClient - Async client

Data Models​

  • JobResult - Execution results
  • JobStatus - Status enumeration
  • CircuitJob - Job representation
  • BackendInfo - Backend information
  • ProviderInfo - Provider details
  • SupplierInfo - Supplier metadata

Exceptions​

  • QCOSError - Base exception
  • AuthenticationError - Invalid credentials
  • ValidationError - Invalid input
  • RateLimitError - Rate limit exceeded
  • JobNotFoundError - Job not found
  • TimeoutError - Request timeout

Licensing​

  • QCOSLicense - License manager
  • LicenseError - License errors
  • FeatureNotLicensed - Feature not available
  • get_license() - Get current license
  • require_license() - Decorator
  • require_feature(feature) - Decorator

CLI Commands​

CommandDescription
softqcos --versionShow version
softqcos --helpShow help
softqcos --legalLegal information
softqcos infoSystem information
softqcos activateActivate license
softqcos statusLicense status
softqcos deactivateRemove license
softqcos verifyVerify evidence bundle

Platform Support​

PlatformSDKCLI
Linux x86_64✅ Python 3.11, 3.12✅
macOS ARM64✅ Python 3.11✅
Windows🔜 Coming soon✅

© 2024-2026 SoftQuantus innovative OÜ. All Rights Reserved.