Generated banner for Cudaq Guide
Generated logo for Cudaq Guide

Cudaq Guide

NVIDIAOfficialCreated by CUDA-Q TeamDistributed by NVIDIA

  • Skill
  • Tool integration
  • Software development
  • Apache-2.0
  • Medium risk

From the author

Use for CUDA-Q setup, simulation targets, QPU access, and @cudaq.kernel authoring guidance.
— the description by CUDA-Q Team

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The CUDA-Q Guide provides comprehensive support for developers working with NVIDIA's CUDA-Q programming model. It covers the full lifecycle of quantum development, including environment setup for Python and C++, selection of simulation targets (GPU-accelerated or CPU-only), and integration with real QPU hardware. The skill also offers deep-dive assistance for authoring @cudaq.kernel code, including execution API selection, kernel-language constraints, and debugging common compilation or runtime issues.

What it does

  • Walks users through CUDA-Q installation and validation on various platforms.
  • Assists in selecting appropriate simulation backends, including multi-GPU and tensor-network targets.
  • Provides best practices for authoring and debugging Python @cudaq.kernel code.
  • Guides users through connecting to and executing jobs on real QPU hardware providers.
  • Explains how to parallelize quantum workloads across GPUs or QPUs.
  • Offers troubleshooting steps for common import, compilation, and execution errors.

When to use it

  • When setting up a new CUDA-Q development environment on Linux, macOS, or WSL.
  • When you need to write or debug a quantum kernel using the @cudaq.kernel decorator.
  • When choosing between simulation backends like qpp-cpu or NVIDIA GPU-accelerated targets.
  • When preparing to submit quantum circuits to external QPU hardware providers.
  • When optimizing quantum workloads for multi-GPU or distributed execution.

Advantages

  • Provides version-aware guidance for CUDA-Q 0.14 and 0.15 APIs.
  • Centralizes documentation for both onboarding and advanced kernel authoring.
  • Helps avoid common pitfalls like incorrect execution API selection or kernel-language violations.
  • Streamlines the process of configuring provider-specific QPU access.

Usage examples

“/cudaq-guide install”
The agent provides step-by-step installation instructions for Python or C++, followed by a validation test using a Bell-state kernel.
“/cudaq-guide author”
The agent explains how to structure a kernel, select the correct execution API (e.g., sample vs. observe), and debug common compiler issues.
“/cudaq-guide qpu”
The agent initiates a dialogue to identify the target QPU technology and guides the user through secure credential configuration.
“/cudaq-guide gpu-sim”
The agent helps the user select the optimal simulation backend based on their hardware availability and performance requirements.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/nvidia/cudaq-guide/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip cudaq-guide.zip -d .agents/skills

Documentation by CUDA-Q Team

CUDA-Q Guide

Purpose

Guide users through CUDA-Q installation, basic kernels, GPU simulation targets, QPU access, built-in applications, multi-GPU execution, and Python @cudaq.kernel authoring. For Qiskit-to-CUDA-Q ports, route to the cudaq-importing skill instead.

Prerequisites

  • Python 3.10+ for Python CUDA-Q workflows.

  • CUDA Toolkit and an NVIDIA GPU for GPU-accelerated targets on Linux.

  • CPU-only simulation is available through qpp-cpu; macOS is CPU-only.

  • C++ workflows require Linux or WSL and C++20.

  • QPU workflows require provider-specific credentials and accounts.

Instructions

  • Invoke with /cudaq-guide [argument].

  • If no argument is given, display the onboarding menu and ask which topic the user wants.

  • Use the routing table below to choose the relevant reference file.

  • Read local CUDA-Q documentation files when the answer depends on a specific CUDA-Q version or backend behavior.

  • Do not answer Qiskit porting questions from this skill; use cudaq-importing.

Routing by Argument

ArgumentActionReference
installWalk through Python or C++ installation and validation.references/onboarding.md
test-programBuild and run a Bell-state kernel.references/onboarding.md
gpu-simSelect GPU, multi-GPU, tensor-network, or CPU targets.references/onboarding.md
qpuGuide provider selection and credential-safe QPU setup.references/onboarding.md
applicationsSummarize CUDA-Q application areas and notebooks.references/onboarding.md
parallelizeChoose mgpu, mqpu, async dispatch, or distributed observe.references/onboarding.md
authorAuthor CUDA-Q Python kernels, select execution APIs, and debug compiler issues.references/authoring.md
(none)Print the menu below and ask which topic to explore.This file

Menu

CUDA-Q Getting Started

CUDA-Q is NVIDIA's unified quantum-classical programming model for CPUs, GPUs, and QPUs.
Supports Python and C++. Docs: https://nvidia.github.io/cuda-quantum/latest/

Choose a topic:
  /cudaq-guide install         Install CUDA-Q
  /cudaq-guide test-program    Write and run a Bell-state kernel
  /cudaq-guide gpu-sim         Accelerate simulation on NVIDIA GPUs
  /cudaq-guide qpu             Connect to real QPU hardware
  /cudaq-guide applications    Explore what you can build
  /cudaq-guide parallelize     Run across GPUs or QPUs
  /cudaq-guide author          Author @cudaq.kernel Python code

Reference Files

  • references/onboarding.md: installation, test program, GPU targets, QPU providers, application areas, parallelization modes, examples, and platform troubleshooting.

  • references/authoring.md: execution APIs, kernel-language constraints, silent-failure pitfalls, recurring coding patterns, resource metrics, debugging, and validation.

Limitations

  • Guidance targets CUDA-Q Python/C++ workflows, with authoring details focused on decorator-mode Python APIs used in CUDA-Q 0.14 and 0.15.

  • GPU and multi-GPU support depends on local CUDA-Q, CUDA Toolkit, driver, MPI, and hardware availability.

  • QPU access and target options are provider-specific and may change; verify against local docs before giving operational steps.

Troubleshooting

  • Import error after pip install cudaq: check Python 3.10+ and supported OS.

  • No GPU detected: verify CUDA Toolkit and nvidia-smi; fall back to qpp-cpu.

  • Kernel compile error: read references/authoring.md and check the restricted kernel-language subset.

  • Version-specific behavior differs: compare cudaq.__version__ with the latest documentation, then review relevant documentation or source changes when debugging an installed version that is not the latest release.

  • QPU submission fails: verify provider credentials are set as environment variables or through a secrets manager, never hardcoded.

  • Documentation lookup fails: retry transient MCP or repository lookup once, then fall back to local docs or official CUDA-Q documentation.

Files

BENCHMARK.md

Skill Benchmark: cudaq-guide

✅ Overall verdict: PASS — Recommended for publication

Publication Recommendation

Recommended for publication based on the completed evaluation evidence in this report.

Evaluation Metadata

  • Skill: cudaq-guide

  • Evaluation date: 2026-09-11

  • Evaluator version: 1.5.6

  • Agents: Claude Code (aws/anthropic/bedrock-claude-opus-4-8), Codex (openai/openai/gpt-5.5)

  • Tasks: 13 evaluation tasks (10 positive, 3 negative)

  • Dataset digest: sha256:7884d2878ed008a3969a7668a02fb2f9fda8e70495368a69ca8bf4ce1f6071dd (skill-evaluator-dataset-snapshot/1)

  • Attempts per task: 3

  • Environment: k8s-sandbox

  • Tier 2 evidence: required for publication

  • Tier 3 evidence: required for publication

Each task attempt ran in its own isolated sandbox pod.

What This Report Answers

The three-tier evaluation checks whether the skill:

  • is safe to use;

  • produces correct answers;

  • is discovered and activated when needed;

  • helps the agent complete the user's goal and expected workflow; and

  • avoids wasted skill and tool usage.

Results at a Glance

MeasureClaude Code (Baseline → Skill Uplift)Codex (Baseline → Skill Uplift)
Overall93.6% — baseline ran, but no comparable score was available; uplift unavailable89.2% — baseline ran, but no comparable score was available; uplift unavailable
Security100.0% → 100.0% (±0.0 points)85.7% → 92.3% (+6.6 points)
Correctness92.3% → 98.5% (+6.2 points)90.0% → 98.5% (+8.5 points)
Discoverability97.5% — baseline ran, but no comparable score was available; uplift unavailable92.0% — baseline ran, but no comparable score was available; uplift unavailable
Effectiveness69.2% → 79.9% (+10.7 points)66.0% → 86.1% (+20.1 points)
Efficiency91.9% — baseline ran, but no comparable score was available; uplift unavailable77.1% — baseline ran, but no comparable score was available; uplift unavailable

How to read this table: baseline is the same task attempted without the target skill. Scores are rounded to one decimal; threshold-adjacent values use additional precision so their displayed band matches the verdict. Uplift is derived from those displayed scores and shown in percentage points.

Example: 47.0% → 92.0% (+45.0 points) means the skill-assisted run scored 92.0%, 45.0 percentage points above its 47.0% no-skill baseline.

A partial dimension was calculated from only the available configured signals; review the detailed report before relying on it.

Token Usage

Actual Tier 3 execution usage is reported for every observed agent/case pair and both conditions.

AgentDataset caseWith skillWithout skillDeltaChangeCoverage
claude-codeAll cases1,666,1181,251,598+414,520+33.12%skill 13/13; base 13/13
claude-codecudaq-guide-applications-00196,57530,095+66,480+220.90%skill 1/1; base 1/1
claude-codecudaq-guide-author-adjoint-001103,56265,498+38,064+58.11%skill 1/1; base 1/1
claude-codecudaq-guide-author-api-001102,25430,416+71,838+236.18%skill 1/1; base 1/1
claude-codecudaq-guide-author-constraint-001102,286133,926-31,640-23.62%skill 1/1; base 1/1
claude-codecudaq-guide-gpu-sim-00196,54231,244+65,298+208.99%skill 1/1; base 1/1
claude-codecudaq-guide-install-00196,78331,099+65,684+211.21%skill 1/1; base 1/1
claude-codecudaq-guide-neg-00129,09929,092+7+0.02%skill 1/1; base 1/1
claude-codecudaq-guide-neg-00229,41729,600-183-0.62%skill 1/1; base 1/1
claude-codecudaq-guide-neg-003155,890191,018-35,128-18.39%skill 1/1; base 1/1
claude-codecudaq-guide-parallelize-00196,69631,451+65,245+207.45%skill 1/1; base 1/1
claude-codecudaq-guide-qpu-001171,868162,627+9,241+5.68%skill 1/1; base 1/1
claude-codecudaq-guide-route-qiskit-001137,822124,365+13,457+10.82%skill 1/1; base 1/1
claude-codecudaq-guide-test-program-001447,324361,167+86,157+23.86%skill 1/1; base 1/1
codexAll cases1,861,6221,290,210N/AN/Askill 13/13; base 14/14
codexcudaq-guide-applications-00159,61032,305+27,305+84.52%skill 1/1; base 1/1
codexcudaq-guide-author-adjoint-00164,36494,709N/AN/Askill 1/1; base 2/2
codexcudaq-guide-author-api-00145,99924,417+21,582+88.39%skill 1/1; base 1/1
codexcudaq-guide-author-constraint-00146,23344,952+1,281+2.85%skill 1/1; base 1/1
codexcudaq-guide-gpu-sim-00178,98417,935+61,049+340.39%skill 1/1; base 1/1
codexcudaq-guide-install-00175,78337,171+38,612+103.88%skill 1/1; base 1/1
codexcudaq-guide-neg-00113,27213,234+38+0.29%skill 1/1; base 1/1
codexcudaq-guide-neg-00213,38013,308+72+0.54%skill 1/1; base 1/1
codexcudaq-guide-neg-003532,599598,297-65,698-10.98%skill 1/1; base 1/1
codexcudaq-guide-parallelize-00150,30725,488+24,819+97.38%skill 1/1; base 1/1
codexcudaq-guide-qpu-00187,17846,231+40,947+88.57%skill 1/1; base 1/1
codexcudaq-guide-route-qiskit-00146,71244,623+2,089+4.68%skill 1/1; base 1/1
codexcudaq-guide-test-program-001747,201297,540+449,661+151.13%skill 1/1; base 1/1
ALL AGENTSDataset aggregate3,527,7402,541,808N/AN/Askill 26/26; base 27/27

Prompt tokens include cached reads, so total tokens are prompt + completion (cached is not added twice). The Efficiency score uses (prompt - cached) + completion. N/A means the relevant trajectory counters were not available; coverage is never estimated.

Tier Status

TierPurposeStatusEvidence
Tier 1Static validationPASSED WITH OBSERVATIONS11 validator(s); 4 finding(s)
Tier 2Semantic deduplicationPASSED2 validator(s); 0 finding(s)
Tier 3Live agent evaluationPASS2 agent(s); 13 task(s)

Findings and Observations

<details> <summary>Show detailed findings and successful checks</summary>

  • MEDIUM SCHEMA/frontmatter_field_placement: Root field 'author' is ignored; use 'metadata.author' (skills/cudaq-guide/SKILL.md)

  • MEDIUM SCHEMA/frontmatter_field_placement: Root field 'tags' is ignored; use 'metadata.tags' (skills/cudaq-guide/SKILL.md)

  • MEDIUM SCHEMA/frontmatter_field_placement: Root field 'version' is ignored; use 'metadata.version' (skills/cudaq-guide/SKILL.md)

  • MEDIUM SCHEMA/body_recommended_section: Missing recommended section: '## Examples' (skills/cudaq-guide/SKILL.md)

</details>

Scoring Methodology

<details> <summary>Show dimension definitions, source signals, and thresholds</summary>

DimensionQuestionScored signals
SecurityIs it safe to use?security (100%)
CorrectnessIs the answer correct?accuracy (100%)
DiscoverabilityWas the right skill loaded when needed?skill_execution (100%)
EffectivenessDid the skill help complete the task?goal_accuracy (50%) + behavior_check (50%)
EfficiencyDid it avoid wasted tool calls and token usage?skill_efficiency (50%) + token_efficiency (50%)
  • Dimension bands: PASS at 50% or above; NEUTRAL from 40% to below 50%; FAIL below 40%.

  • Overall Tier 3 lift: PASS at +5 points or more; FAIL at -10 points or less; values between those bands are NEUTRAL.

  • Overall verdict: PASS only when every configured dimension passes for at least one supported agent. Lift is reported as diagnostic evidence and does not override this gate.

  • The 50% attempt pass threshold is a separate per-task gate; it is not the dimension pass threshold.

  • Effectiveness is the equal-weight mean of goal completion (goal_accuracy) and expected workflow adherence (behavior_check).

  • Efficiency is 50% tool-call productivity (the backward-compatible skill_efficiency wire id) and 50% token_efficiency. Positive-case skill routing is scored under Discoverability, not Efficiency; a negative case without a routing target is N/A. N/A sources are omitted, remaining weights are renormalized, and the dimension is marked partial.

Signals present in this run:

  • security (Security): unsafe operations, secret leakage, and unauthorized access.

  • skill_execution (Skill Execution): whether the expected skill was selected, decoys were avoided, and the workflow executed.

  • skill_efficiency (Tool Productivity): tool-call productivity (legacy wire id; routing is scored under Discoverability).

  • accuracy (Accuracy): final-answer correctness against the reference answer.

  • goal_accuracy (Goal Accuracy): whether the user's goal was achieved.

  • behavior_check (Behavior Check): whether the expected workflow behavior was followed.

  • token_efficiency (Token Efficiency): actual uncached prompt plus completion usage (50% of Efficiency).

</details>

Freshness

Regenerate this benchmark when the skill, evaluation dataset, target agent/model, evaluator version, environment, or scoring policy changes.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Python

The author says: Python 3.10+, C++ 20

Security

What our scanner noticed· Medium risk

  • Large base64-encoded blobs
  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
CUDA-Q Team
Publisher
NVIDIA (Official)
Distributed by
NVIDIA
Source
NVIDIA/skills · skills/cudaq-guide · commit fce3cca
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE-APACHE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by CUDA-Q Team or NVIDIA.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download cudaq-guide.zip