Skip to content

installation.md

Latest commit

 

History

History
103 lines (73 loc) · 2.43 KB

installation.md

File metadata and controls

103 lines (73 loc) · 2.43 KB
Raw

Installation

Looking for a complete setup guide? See Getting Started for a step-by-step walkthrough.

Requirements

Requirement Version Notes
Python 3.10 - 3.13 Required
Origin Quantum Account - API key required

One-Click Setup (Recommended)

The setup scripts automate everything: Python check, uv installation, dependency setup, API key configuration, and MCP client setup.

Linux / macOS

git clone https://github.com/OriginQ/qpanda3-runtime-mcp-server.git
cd qpanda3-runtime-mcp-server
chmod +x scripts/setup_configure.sh
./scripts/setup_configure.sh

Common options:

# With API key + auto-configure Claude Desktop
./scripts/setup_configure.sh --api-key YOUR_KEY --mcp claude-desktop

# Interactive mode
./scripts/setup_configure.sh --interactive

# Skip dependency installation
./scripts/setup_configure.sh --skip-deps

Windows

git clone https://github.com/OriginQ/qpanda3-runtime-mcp-server.git
cd qpanda3-runtime-mcp-server

# PowerShell (recommended)
.\scripts\setup_configure.ps1

# Or CMD (basic functionality only)
.\scripts\setup_configure.bat
# With API key + auto-configure Claude Desktop
.\scripts\setup_configure.ps1 -ApiKey "YOUR_KEY" -McpClient claude-desktop

# Interactive mode
.\scripts\setup_configure.ps1 -Interactive

See Configuration for the full CLI reference.

Manual Install

# 1. Clone
git clone https://github.com/OriginQ/qpanda3-runtime-mcp-server.git
cd qpanda3-runtime-mcp-server

# 2. Install dependencies (uv recommended)
uv sync

# 3. Configure API key
cp .env.example .env
# Edit .env and set QPANDA3_API_KEY=your_api_key_here

Using pip instead of uv:

python -m venv .venv
source .venv/bin/activate   # Linux/macOS
# .venv\Scripts\activate    # Windows
pip install -e .
pip install qpanda3-runtime

Verify

.venv/bin/python -m qpanda3_runtime_mcp_server --help

Troubleshooting

Problem Solution
command not found Run pip install -e . or use uv run
ModuleNotFoundError Activate virtual environment or run uv sync
ImportError: qpanda3_runtime Install runtime: pip install qpanda3-runtime

Next Steps