diff --git a/docs/additional-resources/_toc.json b/docs/additional-resources/_toc.json new file mode 100644 index 00000000000..804c31b780a --- /dev/null +++ b/docs/additional-resources/_toc.json @@ -0,0 +1,171 @@ +{ + "parentUrl": "/docs/guides", + "parentLabel": "Documentation", + "title": "Additional resources", + "collapsed": true, + "children": [ + { + "title": "Additional resources", + "url": "/docs/additional-resources" + }, + { + "title": "Support and FAQ", + "children": [ + { + "title": "Support", + "url": "/docs/additional-resources/support" + }, + { + "title": "Frequently-asked questions", + "url": "/docs/additional-resources/faq" + } + ] + }, + { + "title": "Development workflow", + "url": "/docs/additional-resources/intro-to-patterns" + }, + { + "title": "Migration guides", + "children": [ + { + "title": "Migrate to Qiskit 2.0", + "children": [ + { + "title": "Qiskit v2.0 migration guide", + "url": "/docs/additional-resources/qiskit-2.0" + }, + { + "title": "Migrate from BackendV1 to BackendV2", + "url": "/docs/additional-resources/qiskit-backendv1-to-v2" + } + ] + }, + { + "title": "Migrate to Qiskit 1.0", + "children": [ + { + "title": "Introduction", + "url": "/docs/additional-resources/qiskit-1.0" + }, + { + "title": "Understand the breaking package changes", + "url": "/docs/additional-resources/metapackage-migration" + }, + { + "title": "Install the new Qiskit v1.0 package", + "url": "/docs/additional-resources/qiskit-1.0-installation" + }, + { + "title": "Qiskit v1.0 feature changes", + "url": "/docs/additional-resources/qiskit-1.0-features" + } + ] + }, + { + "title": "Migrate from Sampler to Executor", + "url": "/docs/additional-resources/migrate-from-sampler-to-executor", + "isNew": true, + "isNewDate": "2026-08-06" + }, + { + "title": "Migrate from Qiskit Pulse to fractional gates", + "url": "/docs/additional-resources/pulse-migration" + }, + { + "title": "Migrate to local simulators", + "url": "/docs/additional-resources/local-simulators" + } + ] + }, + { + "title": "Open-source resources", + "children": [ + { + "title": "Introduction", + "url": "/docs/additional-resources/open-source" + }, + { + "title": "Code of conduct", + "url": "/docs/additional-resources/code-of-conduct" + }, + { + "title": "Contributor license agreements", + "children": [ + { + "title": "Individual contributor", + "url": "/docs/open-source/qiskit-cla.pdf" + }, + { + "title": "Corporate contributor", + "url": "/docs/open-source/qiskit-corporate-cla.pdf" + } + ] + }, + { + "title": "Qiskit SDK", + "children": [ + { + "title": "Version strategy", + "url": "/docs/additional-resources/qiskit-sdk-version-strategy" + }, + { + "title": "Contributor guide", + "url": "https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md" + }, + { + "title": "Maintainer guide", + "url": "https://github.com/Qiskit/qiskit/blob/main/MAINTAINING.md" + } + ] + }, + { + "title": "Qiskit ecosystem", + "url": "https://www.ibm.com/quantum/ecosystem" + } + ] + }, + { + "title": "Security and compliance", + "collapsed": true, + "children": [ + { + "title": "Securing your data", + "url": "/docs/additional-resources/secure-data" + }, + { + "title": "Understanding your responsibilities when using IBM Quantum Compute Service", + "url": "/docs/additional-resources/responsibilities" + }, + { + "title": "Use virtual private endpoints for VPC", + "url": "/docs/additional-resources/virtual-private-endpoints" + }, + { + "title": "High availability and disaster recovery", + "url": "/docs/additional-resources/ha-dr" + }, + { + "title": "Activity tracking events for IBM Quantum Compute Service", + "url": "/docs/additional-resources/observability-runtime-rest" + }, + { + "title": "Activity tracking events for the IBM Quantum System service", + "url": "/docs/additional-resources/observability-quantum-system" + }, + { + "title": "Authorization roles", + "url": "/docs/additional-resources/authorization-roles" + }, + { + "title": "Repository security policies", + "url": "/docs/additional-resources/security-policies" + }, + { + "title": "Protecting IBM Quantum Compute Service resources with context-based restrictions", + "url": "/docs/additional-resources/context-based-restrictions" + } + ] + } + ] +} diff --git a/docs/guides/authorization-roles.mdx b/docs/additional-resources/authorization-roles.mdx similarity index 100% rename from docs/guides/authorization-roles.mdx rename to docs/additional-resources/authorization-roles.mdx diff --git a/docs/guides/code-of-conduct.mdx b/docs/additional-resources/code-of-conduct.mdx similarity index 100% rename from docs/guides/code-of-conduct.mdx rename to docs/additional-resources/code-of-conduct.mdx diff --git a/docs/guides/context-based-restrictions.mdx b/docs/additional-resources/context-based-restrictions.mdx similarity index 100% rename from docs/guides/context-based-restrictions.mdx rename to docs/additional-resources/context-based-restrictions.mdx diff --git a/docs/guides/faq.mdx b/docs/additional-resources/faq.mdx similarity index 100% rename from docs/guides/faq.mdx rename to docs/additional-resources/faq.mdx diff --git a/docs/guides/ha-dr.mdx b/docs/additional-resources/ha-dr.mdx similarity index 100% rename from docs/guides/ha-dr.mdx rename to docs/additional-resources/ha-dr.mdx diff --git a/docs/additional-resources/index.mdx b/docs/additional-resources/index.mdx new file mode 100644 index 00000000000..f0074a1daa8 --- /dev/null +++ b/docs/additional-resources/index.mdx @@ -0,0 +1,50 @@ +--- +title: Additional resources +description: Support, migration guides, open-source resources, and security and compliance information for Qiskit and IBM Quantum. +--- + +# Additional resources + +This section collects support channels, migration guides, open-source project information, and security and compliance documentation for Qiskit and IBM Quantum. + + + + + + + + + + + + diff --git a/docs/guides/intro-to-patterns.mdx b/docs/additional-resources/intro-to-patterns.mdx similarity index 100% rename from docs/guides/intro-to-patterns.mdx rename to docs/additional-resources/intro-to-patterns.mdx diff --git a/docs/guides/local-simulators.mdx b/docs/additional-resources/local-simulators.mdx similarity index 100% rename from docs/guides/local-simulators.mdx rename to docs/additional-resources/local-simulators.mdx diff --git a/docs/guides/metapackage-migration.mdx b/docs/additional-resources/metapackage-migration.mdx similarity index 100% rename from docs/guides/metapackage-migration.mdx rename to docs/additional-resources/metapackage-migration.mdx diff --git a/docs/guides/migrate-from-sampler-to-executor.mdx b/docs/additional-resources/migrate-from-sampler-to-executor.mdx similarity index 100% rename from docs/guides/migrate-from-sampler-to-executor.mdx rename to docs/additional-resources/migrate-from-sampler-to-executor.mdx diff --git a/docs/guides/observability-quantum-system.mdx b/docs/additional-resources/observability-quantum-system.mdx similarity index 100% rename from docs/guides/observability-quantum-system.mdx rename to docs/additional-resources/observability-quantum-system.mdx diff --git a/docs/guides/observability-runtime-rest.mdx b/docs/additional-resources/observability-runtime-rest.mdx similarity index 100% rename from docs/guides/observability-runtime-rest.mdx rename to docs/additional-resources/observability-runtime-rest.mdx diff --git a/docs/guides/open-source.mdx b/docs/additional-resources/open-source.mdx similarity index 100% rename from docs/guides/open-source.mdx rename to docs/additional-resources/open-source.mdx diff --git a/docs/guides/pulse-migration.mdx b/docs/additional-resources/pulse-migration.mdx similarity index 100% rename from docs/guides/pulse-migration.mdx rename to docs/additional-resources/pulse-migration.mdx diff --git a/docs/guides/qiskit-1.0-features.mdx b/docs/additional-resources/qiskit-1.0-features.mdx similarity index 100% rename from docs/guides/qiskit-1.0-features.mdx rename to docs/additional-resources/qiskit-1.0-features.mdx diff --git a/docs/guides/qiskit-1.0-installation.mdx b/docs/additional-resources/qiskit-1.0-installation.mdx similarity index 100% rename from docs/guides/qiskit-1.0-installation.mdx rename to docs/additional-resources/qiskit-1.0-installation.mdx diff --git a/docs/guides/qiskit-1.0.mdx b/docs/additional-resources/qiskit-1.0.mdx similarity index 100% rename from docs/guides/qiskit-1.0.mdx rename to docs/additional-resources/qiskit-1.0.mdx diff --git a/docs/guides/qiskit-2.0.mdx b/docs/additional-resources/qiskit-2.0.mdx similarity index 100% rename from docs/guides/qiskit-2.0.mdx rename to docs/additional-resources/qiskit-2.0.mdx diff --git a/docs/guides/qiskit-backendv1-to-v2.mdx b/docs/additional-resources/qiskit-backendv1-to-v2.mdx similarity index 100% rename from docs/guides/qiskit-backendv1-to-v2.mdx rename to docs/additional-resources/qiskit-backendv1-to-v2.mdx diff --git a/docs/guides/qiskit-sdk-version-strategy.mdx b/docs/additional-resources/qiskit-sdk-version-strategy.mdx similarity index 100% rename from docs/guides/qiskit-sdk-version-strategy.mdx rename to docs/additional-resources/qiskit-sdk-version-strategy.mdx diff --git a/docs/guides/responsibilities.mdx b/docs/additional-resources/responsibilities.mdx similarity index 100% rename from docs/guides/responsibilities.mdx rename to docs/additional-resources/responsibilities.mdx diff --git a/docs/guides/secure-data.mdx b/docs/additional-resources/secure-data.mdx similarity index 100% rename from docs/guides/secure-data.mdx rename to docs/additional-resources/secure-data.mdx diff --git a/docs/guides/security-policies.mdx b/docs/additional-resources/security-policies.mdx similarity index 100% rename from docs/guides/security-policies.mdx rename to docs/additional-resources/security-policies.mdx diff --git a/docs/guides/support.mdx b/docs/additional-resources/support.mdx similarity index 100% rename from docs/guides/support.mdx rename to docs/additional-resources/support.mdx diff --git a/docs/guides/virtual-private-endpoints.mdx b/docs/additional-resources/virtual-private-endpoints.mdx similarity index 100% rename from docs/guides/virtual-private-endpoints.mdx rename to docs/additional-resources/virtual-private-endpoints.mdx diff --git a/docs/api/functions/_toc.json b/docs/api/functions/_toc.json index 1b91fdee350..3eb3efc8e6f 100644 --- a/docs/api/functions/_toc.json +++ b/docs/api/functions/_toc.json @@ -6,70 +6,91 @@ "url": "/docs/api/functions" }, { - "title": "Circuit functions", + "title": "Optimization", "untranslatable": true, "children": [ { - "title": "Algorithmiq Tensor-network error mitigation", - "url": "/docs/api/functions/algorithmiq-tem", - "untranslatable": true + "title": "Kipu Quantum Iskay Quantum Optimizer", + "url": "/docs/api/functions/kipu-optimization", + "untranslatable": true }, { - "title": "Q-CTRL Performance Management", - "url": "/docs/api/functions/q-ctrl-performance-management", + "title": "Q-CTRL Optimization Solver", + "url": "/docs/api/functions/q-ctrl-optimization-solver", "untranslatable": true }, { - "title": "Qedma QESEM", - "url": "/docs/api/functions/qedma-qesem", + "title": "Quantum Portfolio Optimizer by Global Data Quantum", + "url": "/docs/api/functions/global-data-quantum-optimizer", "untranslatable": true - }, - { - "title": "Quantum Elements Orbit", - "url": "/docs/api/functions/quantum-elements-orbit", - "untranslatable": true, - "isNew":true, - "isNewDate": "2026-07-22" } ], "collapsible": false }, { - "title": "Application functions", + "title": "Machine learning", "untranslatable": true, "children": [ - { - "title": "Kipu Quantum Iskay Quantum Optimizer", - "url": "/docs/api/functions/kipu-optimization", - "untranslatable": true - }, { "title": "Multiverse Computing Singularity", "url": "/docs/api/functions/multiverse-computing-singularity", "untranslatable": true - }, + } + ], + "collapsible": false + }, + { + "title": "Differential equations", + "untranslatable": true, + "children": [ { - "title": "Q-CTRL Optimization Solver", - "url": "/docs/api/functions/q-ctrl-optimization-solver", + "title": "QUICK-PDE: A Qiskit Function by ColibriTD", + "url": "/docs/api/functions/colibritd-pde", "untranslatable": true - }, + } + ], + "collapsible": false + }, + { + "title": "Hamiltonian simulation", + "untranslatable": true, + "children": [ { - "title": "Quantum Portfolio Optimizer by Global Data Quantum", - "url": "/docs/api/functions/global-data-quantum-optimizer", + "title": "Qunova Computing HI-VQE Chemistry", + "url": "/docs/api/functions/qunova-chemistry", + "untranslatable": true + } + ], + "collapsible": false + }, + { + "title": "Circuit performance", + "untranslatable": true, + "children": [ + { + "title": "Algorithmiq Tensor-network error mitigation", + "url": "/docs/api/functions/algorithmiq-tem", "untranslatable": true }, { - "title": "QUICK-PDE: A Qiskit Function by ColibriTD", - "url": "/docs/api/functions/colibritd-pde", + "title": "Q-CTRL Performance Management", + "url": "/docs/api/functions/q-ctrl-performance-management", "untranslatable": true }, { - "title": "Qunova Computing HI-VQE Chemistry", - "url": "/docs/api/functions/qunova-chemistry", + "title": "Qedma QESEM", + "url": "/docs/api/functions/qedma-qesem", "untranslatable": true + }, + { + "title": "Quantum Elements Orbit", + "url": "/docs/api/functions/quantum-elements-orbit", + "untranslatable": true, + "isNew":true, + "isNewDate": "2026-07-22" } ], "collapsible": false } ] -} \ No newline at end of file +} diff --git a/docs/applications-research-tools/_toc.json b/docs/applications-research-tools/_toc.json new file mode 100644 index 00000000000..d891404b520 --- /dev/null +++ b/docs/applications-research-tools/_toc.json @@ -0,0 +1,134 @@ +{ + "parentUrl": "/docs/guides", + "parentLabel": "Documentation", + "title": "Applications research tools", + "collapsed": true, + "children": [ + { + "title": "Get started", + "children": [ + { + "title": "Introduction", + "url": "/docs/applications-research-tools" + }, + { + "title": "Set up access", + "url": "/docs/applications-research-tools/functions-get-started" + }, + { + "title": "Qiskit Function templates", + "url": "/docs/applications-research-tools/qiskit-function-templates" + } + ], + "collapsible": false + }, + { + "title": "Function domains", + "children": [ + { + "title": "Optimization", + "children": [ + { + "title": "Kipu Quantum Iskay Quantum Optimizer", + "url": "/docs/applications-research-tools/kipu-optimization" + }, + { + "title": "Q-CTRL Optimization Solver", + "url": "/docs/applications-research-tools/q-ctrl-optimization-solver" + }, + { + "title": "Quantum Portfolio Optimizer: A Qiskit Function by Global Data Quantum", + "url": "/docs/applications-research-tools/global-data-quantum-optimizer" + } + ] + }, + { + "title": "Machine learning", + "children": [ + { + "title": "Multiverse Computing Singularity", + "url": "/docs/applications-research-tools/multiverse-computing-singularity" + } + ] + }, + { + "title": "Differential equations", + "children": [ + { + "title": "QUICK-PDE: A Qiskit Function by ColibriTD", + "url": "/docs/applications-research-tools/colibritd-pde" + } + ] + }, + { + "title": "Hamiltonian simulation", + "children": [ + { + "title": "Qunova Computing HI-VQE Chemistry", + "url": "/docs/applications-research-tools/qunova-chemistry" + }, + { + "title": "Template for Hamiltonian simulation", + "url": "/docs/applications-research-tools/function-template-hamiltonian-simulation" + }, + { + "title": "Template for chemistry simulation", + "url": "/docs/applications-research-tools/function-template-chemistry-workflow" + } + ] + } + ], + "collapsible": false + }, + { + "title": "Improve circuit performance", + "children": [ + { + "title": "Algorithmiq Tensor-network error mitigation", + "url": "/docs/applications-research-tools/algorithmiq-tem" + }, + { + "title": "Q-CTRL Performance Management", + "url": "/docs/applications-research-tools/q-ctrl-performance-management" + }, + { + "title": "Qedma QESEM", + "url": "/docs/applications-research-tools/qedma-qesem" + }, + { + "title": "Quantum Elements Orbit", + "url": "/docs/applications-research-tools/quantum-elements-orbit", + "isNew": true, + "isNewDate": "2026-07-22" + } + ], + "collapsible": false + }, + { + "title": "Qiskit Serverless", + "children": [ + { + "title": "Introduction to Qiskit Serverless", + "url": "/docs/applications-research-tools/serverless" + }, + { + "title": "Write your first Qiskit Serverless program", + "url": "/docs/applications-research-tools/serverless-first-program" + }, + { + "title": "Run your first Qiskit Serverless workload remotely", + "url": "/docs/applications-research-tools/serverless-run-first-workload" + }, + { + "title": "Manage Qiskit Serverless compute and data resources", + "url": "/docs/applications-research-tools/serverless-manage-resources" + }, + { + "title": "Port code to Qiskit Serverless", + "url": "/docs/applications-research-tools/serverless-port-code" + } + ], + "collapsible": false + } + ] +} diff --git a/docs/guides/algorithmiq-tem.ipynb b/docs/applications-research-tools/algorithmiq-tem.ipynb similarity index 100% rename from docs/guides/algorithmiq-tem.ipynb rename to docs/applications-research-tools/algorithmiq-tem.ipynb diff --git a/docs/guides/colibritd-pde.ipynb b/docs/applications-research-tools/colibritd-pde.ipynb similarity index 100% rename from docs/guides/colibritd-pde.ipynb rename to docs/applications-research-tools/colibritd-pde.ipynb diff --git a/docs/guides/function-template-chemistry-workflow.ipynb b/docs/applications-research-tools/function-template-chemistry-workflow.ipynb similarity index 100% rename from docs/guides/function-template-chemistry-workflow.ipynb rename to docs/applications-research-tools/function-template-chemistry-workflow.ipynb diff --git a/docs/guides/function-template-hamiltonian-simulation.ipynb b/docs/applications-research-tools/function-template-hamiltonian-simulation.ipynb similarity index 100% rename from docs/guides/function-template-hamiltonian-simulation.ipynb rename to docs/applications-research-tools/function-template-hamiltonian-simulation.ipynb diff --git a/docs/guides/functions-get-started.ipynb b/docs/applications-research-tools/functions-get-started.ipynb similarity index 100% rename from docs/guides/functions-get-started.ipynb rename to docs/applications-research-tools/functions-get-started.ipynb diff --git a/docs/guides/global-data-quantum-optimizer.ipynb b/docs/applications-research-tools/global-data-quantum-optimizer.ipynb similarity index 100% rename from docs/guides/global-data-quantum-optimizer.ipynb rename to docs/applications-research-tools/global-data-quantum-optimizer.ipynb diff --git a/docs/applications-research-tools/index.ipynb b/docs/applications-research-tools/index.ipynb new file mode 100644 index 00000000000..12d37ec66cd --- /dev/null +++ b/docs/applications-research-tools/index.ipynb @@ -0,0 +1,241 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "id": "2ee21f3f-2a40-486f-9721-d8a358a87aa1", + "metadata": {}, + "source": [ + "---\n", + "title: Introduction to Qiskit Functions\n", + "description: Explore IBM Qiskit Functions Catalog, abstracted circuit function and application function services designed to accelerate research and application prototyping.\n", + "---\n", + "\n", + "\n", + "{/* cspell:ignore Jarman, HIVQE, Cadavid, Chandarana, Leclerc, Sachdeva, HUBO, Filippov, Downfolding, Aharonov, Mundada, Yamauchi, supersymmetric, Paterakis, Gharibyan, Jaffali, Pellow */}" + ] + }, + { + "cell_type": "markdown", + "id": "97b94d47-ba58-4251-91f2-93097e50f2c9", + "metadata": {}, + "source": [ + "# Introduction to Qiskit Functions\n", + "\n", + "* Qiskit Functions are an experimental feature available only to IBM Quantum® Premium Plan, Flex Plan, and On-Prem (via IBM Quantum Platform API) Plan users. They are in preview release status and subject to change.\n", + "" + ] + }, + { + "cell_type": "markdown", + "id": "a4c425ca-c6c6-4232-b4b9-b2a365d10ad9", + "metadata": { + "tags": [ + "version-info" + ] + }, + "source": [] + }, + { + "cell_type": "markdown", + "id": "1fe03d0f-c7bb-439b-b98e-91ca400b62fc", + "metadata": {}, + "source": [ + "Qiskit Functions simplify and accelerate utility-scale algorithm discovery and application development, by abstracting away parts of the quantum software development workflow. In this way, Qiskit Functions free up time normally spent hand-writing code and fine-tuning experiments.\n", + "\n", + "[Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions)\n", + "\n", + "![Overview of Qiskit Functions](/docs/images/guides/functions/functions-overview.svg)\n", + "Functions come in two forms:\n", + "\n", + "| Type | What does it do? | Example inputs and outputs | Who is it for? |\n", + "| - | - | - | - |\n", + "| Circuit function | Simplified interface for running circuits. Abstracts transpilation, error suppression, and error mitigation | **Input**: Abstract `PUB` objects
**Output**: Mitigated expectation values | Researchers using Qiskit to discover new algorithms and applications, without needing to focus on optimizing for hardware or handling error. Circuit functions can be used to build custom application functions. |\n", + "| Application function | Covers higher-level tasks, such as exploring algorithms and domain-specific use cases. Abstracts quantum workflow to solve tasks, with classical inputs and outputs | **Input**: Molecules, graphs
**Output**: Ground + excited state energy, optimal values for cost function | Researchers in non-quantum domains, integrating quantum into existing large-scale classical workflows, without needing to map classical data to quantum circuits. |" + ] + }, + { + "cell_type": "markdown", + "source": [ + "## Browse by domain\n", + "\n", + "Application functions and function templates are organized by the problem domain they target. Circuit functions are cross-cutting and apply across domains.\n", + "\n", + "### Optimization\n", + "\n", + " \n", + "\n", + " \n", + "\n", + " \n", + "\n", + "\n", + "### Machine learning\n", + "\n", + " \n", + "\n", + "\n", + "### Differential equations\n", + "\n", + " \n", + "\n", + "\n", + "### Hamiltonian simulation\n", + "\n", + " \n", + "\n", + "\n", + "### Circuit performance\n", + "\n", + " \n", + "\n", + " \n", + "\n", + " \n", + "\n", + " \n", + "\n", + "\n", + "### Qiskit Function templates\n", + "\n", + " \n", + "\n", + " \n", + "\n", + " \n", + "" + ], + "metadata": {}, + "id": "83f2c64b-36f4-4143-ba96-4394fde73726" + }, + { + "cell_type": "markdown", + "id": "5e5b0531-f286-4573-8b1e-664ca5496d2d", + "metadata": {}, + "source": [ + "Functions are provided by IBM® and third-party partners. Each is performant for specific workload characteristics and has unique performance-tuning options.\n", + "\n", + "## Detailed comparison\n", + "\n", + "\n", + "### Circuit functions\n", + "\n", + "| Name | Provider | Recommended use | Unique benefits |\n", + "|---|---|---|---|\n", + "| Tensor-Network Error Mitigation

[Guide](/docs/guides/algorithmiq-tem)
[API reference](/docs/api/functions/algorithmiq-tem) | Algorithmiq | Workloads that have low-weight observables and loop-free circuits. | Reduces measurement overhead and variance, outperforming standard error mitigation baselines such as Zero Noise Extrapolation (ZNE) and Probabilistic Error Cancellation (PEC) for relevant circuit classes. |\n", + "| QESEM: Error Suppression and Error Mitigation

[Guide](/docs/guides/qedma-qesem)
[API reference](/docs/api/functions/qedma-qesem) | Qedma | Workloads that include circuits with fractional or parameterized gates, high-weight observables, and workflows that require unbiased expectation values and accurate runtime estimates. | Produces unbiased expectation values with lower variance and resource overhead, outperforming ZNE and PEC for relevant circuit classes. |\n", + "| Performance Management

[Guide](/docs/guides/q-ctrl-performance-management)
[API reference](/docs/api/functions/q-ctrl-performance-management) | Q-CTRL | Workloads that contain parametric circuits, deep circuits, or require many circuit executions. | Automatically applies AI-driven error suppression to quantum algorithms, maximizing the performance of IBM devices to deliver accurate results while reducing the number of shots, compute time, and cost required.

Zero-overhead method that improves execution accuracy for the Sampler and the Estimator primitives, compatible with any weight of observables. |\n", + "\n", + "\n", + "### Application functions\n", + "\n", + "| Name | Provider | Recommended use | Unique benefits |\n", + "|---|---|---|---|\n", + "| QUICK-PDE

[Guide](/docs/guides/colibritd-pde)
[API reference](/docs/api/functions/colibritd-pde) | ColibriTD | Use quantum computation for multi-physics PDEs.

Prepare simulation workflows for quantum hardware, while keeping full control over both quantum and physical modeling parameters. | Offers a robust hybrid VQA framework that delivers precise, scalable PDE solutions through advanced solution encoding and spectral methods, making it an ideal entry point for teams trying to build quantum-ready simulation capabilities. |\n", + "| Quantum Portfolio Optimizer

[Guide](/docs/guides/global-data-quantum-optimizer)
[API reference](/docs/api/functions/global-data-quantum-optimizer) | Global Data Quantum | Workloads for financial optimization, seeking optimal portfolio strategies over time while minimizing risk and maximizing returns, enabling trading strategy back-testing. | Solves combinatorial optimization problems through a highly specialized adaptation of the VQE quantum algorithm for this financial use case, using optimized execution strategies and optimizers, along with noise-aware error mitigation techniques tailored to portfolio optimization. |\n", + "| HI-VQE Chemistry

[Guide](/docs/guides/qunova-chemistry)
[API reference](/docs/api/functions/qunova-chemistry) | Qunova Computing | Workloads in computational chemistry, molecular simulation, materials science, or any Hamiltonian simulation that require solving many-body electronic structure problems. | Solves molecular electronic structures by using enhanced SQD with achieving chemical accuracy (1 kcal/mol, 1.6 mHa) for problems modeled with 40 to 60 qubits, outperforming some classical solutions on supercomputers or standard SQD in convergence speed or accuracy, respectively, by orders of magnitude. |\n", + "| Iskay Quantum Optimizer

[Guide](/docs/guides/kipu-optimization)
[API reference](/docs/api/functions/kipu-optimization) | Kipu Quantum | Optimization workloads such as scheduling, logistics, routing, and QUBO/HUBO problems.

| Integrated tunable classical pre- and post-processing methods for the quantum optimization routine.

Delivers runtime advantage over classical solvers (CPLEX, simulated annealing, and tabu search) on selected HUBO benchmarks.

Market Split `ms_5_100`, a hard challenge, solved within hours (see [this tutorial](/docs/tutorials/solve-market-split-problem-with-iskay-quantum-optimizer)). |\n", + "| Singularity Machine Learning

[Guide](/docs/guides/multiverse-computing-singularity)
[API reference](/docs/api/functions/multiverse-computing-singularity) | Multiverse Computing | Classical machine learning classification workflows that could benefit from improved accuracy or computational efficiency by leveraging quantum optimization executed on IBM hardware. | Delivers accuracy comparable to or exceeding classical models such as Random Forest or XGBoost, while operating with significantly fewer learners and a more compact ensemble.

Powered by quantum-optimized voting, it selects the most informative learners and refines decision boundaries, resulting in greater efficiency, reduced model complexity, and more robust performance. |\n", + "| Optimization Solver

[Guide](/docs/guides/q-ctrl-optimization-solver)
[API reference](/docs/api/functions/q-ctrl-optimization-solver) | Q-CTRL | Binary optimization problems or any combinatorial problem that can be mapped to a binary cost function.

Cost functions of any order and problem sizes up to the maximum device scale are supported. | Noise-aware, end-to-end quantum optimization solution that enables inputs of high-level problem definitions and automatically finds accurate solutions to classically challenging combinatorial problems on utility-scale quantum hardware.

It abstracts away complexity by handling error suppression, efficient mapping, and hybrid quantum-classical optimization to solve optimization tasks at full device scale without deep quantum expertise. |" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/docs/applications-research-tools/index.mdx b/docs/applications-research-tools/index.mdx new file mode 100644 index 00000000000..5a891ca35cf --- /dev/null +++ b/docs/applications-research-tools/index.mdx @@ -0,0 +1,174 @@ +--- +title: Introduction to Qiskit Functions +description: Explore IBM Qiskit Functions Catalog, abstracted circuit function and application function services designed to accelerate research and application prototyping. +--- + + +{/* cspell:ignore Jarman, HIVQE, Cadavid, Chandarana, Leclerc, Sachdeva, HUBO, Filippov, Downfolding, Aharonov, Mundada, Yamauchi, supersymmetric, Paterakis, Gharibyan, Jaffali, Pellow */} + +# Introduction to Qiskit Functions + +* Qiskit Functions are an experimental feature available only to IBM Quantum® Premium Plan, Flex Plan, and On-Prem (via IBM Quantum Platform API) Plan users. They are in preview release status and subject to change. + +Qiskit Functions simplify and accelerate utility-scale algorithm discovery and application development, by abstracting away parts of the quantum software development workflow. In this way, Qiskit Functions free up time normally spent hand-writing code and fine-tuning experiments. + +[Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions) + +![Overview of Qiskit Functions](/docs/images/guides/functions/functions-overview.svg) +Functions come in two forms: + +| Type | What does it do? | Example inputs and outputs | Who is it for? | +| - | - | - | - | +| Circuit function | Simplified interface for running circuits. Abstracts transpilation, error suppression, and error mitigation | **Input**: Abstract `PUB` objects
**Output**: Mitigated expectation values | Researchers using Qiskit to discover new algorithms and applications, without needing to focus on optimizing for hardware or handling error. Circuit functions can be used to build custom application functions. | +| Application function | Covers higher-level tasks, such as exploring algorithms and domain-specific use cases. Abstracts quantum workflow to solve tasks, with classical inputs and outputs | **Input**: Molecules, graphs
**Output**: Ground + excited state energy, optimal values for cost function | Researchers in non-quantum domains, integrating quantum into existing large-scale classical workflows, without needing to map classical data to quantum circuits. | + +## Browse by domain + +Application functions and function templates are organized by the problem domain they target. Circuit functions are cross-cutting and apply across domains. + +### Optimization + + + + + + + + +### Machine learning + + + + +### Differential equations + + + + +### Hamiltonian simulation + + + + +### Circuit performance + + + + + + + + + + +### Qiskit Function templates + + + + + + + + +Functions are provided by IBM® and third-party partners. Each is performant for specific workload characteristics and has unique performance-tuning options. + +## Detailed comparison + + +### Circuit functions + +| Name | Provider | Recommended use | Unique benefits | +|---|---|---|---| +| Tensor-Network Error Mitigation

[Guide](/docs/guides/algorithmiq-tem)
[API reference](/docs/api/functions/algorithmiq-tem) | Algorithmiq | Workloads that have low-weight observables and loop-free circuits. | Reduces measurement overhead and variance, outperforming standard error mitigation baselines such as Zero Noise Extrapolation (ZNE) and Probabilistic Error Cancellation (PEC) for relevant circuit classes. | +| QESEM: Error Suppression and Error Mitigation

[Guide](/docs/guides/qedma-qesem)
[API reference](/docs/api/functions/qedma-qesem) | Qedma | Workloads that include circuits with fractional or parameterized gates, high-weight observables, and workflows that require unbiased expectation values and accurate runtime estimates. | Produces unbiased expectation values with lower variance and resource overhead, outperforming ZNE and PEC for relevant circuit classes. | +| Performance Management

[Guide](/docs/guides/q-ctrl-performance-management)
[API reference](/docs/api/functions/q-ctrl-performance-management) | Q-CTRL | Workloads that contain parametric circuits, deep circuits, or require many circuit executions. | Automatically applies AI-driven error suppression to quantum algorithms, maximizing the performance of IBM devices to deliver accurate results while reducing the number of shots, compute time, and cost required.

Zero-overhead method that improves execution accuracy for the Sampler and the Estimator primitives, compatible with any weight of observables. | + + +### Application functions + +| Name | Provider | Recommended use | Unique benefits | +|---|---|---|---| +| QUICK-PDE

[Guide](/docs/guides/colibritd-pde)
[API reference](/docs/api/functions/colibritd-pde) | ColibriTD | Use quantum computation for multi-physics PDEs.

Prepare simulation workflows for quantum hardware, while keeping full control over both quantum and physical modeling parameters. | Offers a robust hybrid VQA framework that delivers precise, scalable PDE solutions through advanced solution encoding and spectral methods, making it an ideal entry point for teams trying to build quantum-ready simulation capabilities. | +| Quantum Portfolio Optimizer

[Guide](/docs/guides/global-data-quantum-optimizer)
[API reference](/docs/api/functions/global-data-quantum-optimizer) | Global Data Quantum | Workloads for financial optimization, seeking optimal portfolio strategies over time while minimizing risk and maximizing returns, enabling trading strategy back-testing. | Solves combinatorial optimization problems through a highly specialized adaptation of the VQE quantum algorithm for this financial use case, using optimized execution strategies and optimizers, along with noise-aware error mitigation techniques tailored to portfolio optimization. | +| HI-VQE Chemistry

[Guide](/docs/guides/qunova-chemistry)
[API reference](/docs/api/functions/qunova-chemistry) | Qunova Computing | Workloads in computational chemistry, molecular simulation, materials science, or any Hamiltonian simulation that require solving many-body electronic structure problems. | Solves molecular electronic structures by using enhanced SQD with achieving chemical accuracy (1 kcal/mol, 1.6 mHa) for problems modeled with 40 to 60 qubits, outperforming some classical solutions on supercomputers or standard SQD in convergence speed or accuracy, respectively, by orders of magnitude. | +| Iskay Quantum Optimizer

[Guide](/docs/guides/kipu-optimization)
[API reference](/docs/api/functions/kipu-optimization) | Kipu Quantum | Optimization workloads such as scheduling, logistics, routing, and QUBO/HUBO problems.

| Integrated tunable classical pre- and post-processing methods for the quantum optimization routine.

Delivers runtime advantage over classical solvers (CPLEX, simulated annealing, and tabu search) on selected HUBO benchmarks.

Market Split `ms_5_100`, a hard challenge, solved within hours (see [this tutorial](/docs/tutorials/solve-market-split-problem-with-iskay-quantum-optimizer)). | +| Singularity Machine Learning

[Guide](/docs/guides/multiverse-computing-singularity)
[API reference](/docs/api/functions/multiverse-computing-singularity) | Multiverse Computing | Classical machine learning classification workflows that could benefit from improved accuracy or computational efficiency by leveraging quantum optimization executed on IBM hardware. | Delivers accuracy comparable to or exceeding classical models such as Random Forest or XGBoost, while operating with significantly fewer learners and a more compact ensemble.

Powered by quantum-optimized voting, it selects the most informative learners and refines decision boundaries, resulting in greater efficiency, reduced model complexity, and more robust performance. | +| Optimization Solver

[Guide](/docs/guides/q-ctrl-optimization-solver)
[API reference](/docs/api/functions/q-ctrl-optimization-solver) | Q-CTRL | Binary optimization problems or any combinatorial problem that can be mapped to a binary cost function.

Cost functions of any order and problem sizes up to the maximum device scale are supported. | Noise-aware, end-to-end quantum optimization solution that enables inputs of high-level problem definitions and automatically finds accurate solutions to classically challenging combinatorial problems on utility-scale quantum hardware.

It abstracts away complexity by handling error suppression, efficient mapping, and hybrid quantum-classical optimization to solve optimization tasks at full device scale without deep quantum expertise. | diff --git a/docs/guides/kipu-optimization.ipynb b/docs/applications-research-tools/kipu-optimization.ipynb similarity index 100% rename from docs/guides/kipu-optimization.ipynb rename to docs/applications-research-tools/kipu-optimization.ipynb diff --git a/docs/guides/multiverse-computing-singularity.ipynb b/docs/applications-research-tools/multiverse-computing-singularity.ipynb similarity index 100% rename from docs/guides/multiverse-computing-singularity.ipynb rename to docs/applications-research-tools/multiverse-computing-singularity.ipynb diff --git a/docs/guides/q-ctrl-optimization-solver.ipynb b/docs/applications-research-tools/q-ctrl-optimization-solver.ipynb similarity index 100% rename from docs/guides/q-ctrl-optimization-solver.ipynb rename to docs/applications-research-tools/q-ctrl-optimization-solver.ipynb diff --git a/docs/guides/q-ctrl-performance-management.ipynb b/docs/applications-research-tools/q-ctrl-performance-management.ipynb similarity index 100% rename from docs/guides/q-ctrl-performance-management.ipynb rename to docs/applications-research-tools/q-ctrl-performance-management.ipynb diff --git a/docs/guides/qedma-qesem.ipynb b/docs/applications-research-tools/qedma-qesem.ipynb similarity index 100% rename from docs/guides/qedma-qesem.ipynb rename to docs/applications-research-tools/qedma-qesem.ipynb diff --git a/docs/guides/qiskit-function-templates.mdx b/docs/applications-research-tools/qiskit-function-templates.mdx similarity index 100% rename from docs/guides/qiskit-function-templates.mdx rename to docs/applications-research-tools/qiskit-function-templates.mdx diff --git a/docs/guides/quantum-elements-orbit.ipynb b/docs/applications-research-tools/quantum-elements-orbit.ipynb similarity index 100% rename from docs/guides/quantum-elements-orbit.ipynb rename to docs/applications-research-tools/quantum-elements-orbit.ipynb diff --git a/docs/guides/qunova-chemistry.ipynb b/docs/applications-research-tools/qunova-chemistry.ipynb similarity index 100% rename from docs/guides/qunova-chemistry.ipynb rename to docs/applications-research-tools/qunova-chemistry.ipynb diff --git a/docs/guides/serverless-first-program.ipynb b/docs/applications-research-tools/serverless-first-program.ipynb similarity index 100% rename from docs/guides/serverless-first-program.ipynb rename to docs/applications-research-tools/serverless-first-program.ipynb diff --git a/docs/guides/serverless-manage-resources.ipynb b/docs/applications-research-tools/serverless-manage-resources.ipynb similarity index 100% rename from docs/guides/serverless-manage-resources.ipynb rename to docs/applications-research-tools/serverless-manage-resources.ipynb diff --git a/docs/guides/serverless-port-code.ipynb b/docs/applications-research-tools/serverless-port-code.ipynb similarity index 100% rename from docs/guides/serverless-port-code.ipynb rename to docs/applications-research-tools/serverless-port-code.ipynb diff --git a/docs/guides/serverless-run-first-workload.ipynb b/docs/applications-research-tools/serverless-run-first-workload.ipynb similarity index 100% rename from docs/guides/serverless-run-first-workload.ipynb rename to docs/applications-research-tools/serverless-run-first-workload.ipynb diff --git a/docs/guides/serverless.mdx b/docs/applications-research-tools/serverless.mdx similarity index 100% rename from docs/guides/serverless.mdx rename to docs/applications-research-tools/serverless.mdx diff --git a/docs/guides/_toc.json b/docs/guides/_toc.json index cae2b4cb602..d647fa0337a 100644 --- a/docs/guides/_toc.json +++ b/docs/guides/_toc.json @@ -54,723 +54,108 @@ "collapsible": false }, { - "title": "Qiskit", + "title": "IBM Quantum services", "children": [ { - "title": "Introduction to Qiskit", - "url": "/docs/guides/tools-intro" - }, - { - "title": "Install", - "children": [ - { - "title": "Install Qiskit", - "url": "/docs/guides/install-qiskit" - }, - { - "title": "Install the Qiskit SDK from source", - "url": "/docs/guides/install-qiskit-source" - }, - { - "title": "Configure the Qiskit SDK locally", - "url": "/docs/guides/configure-qiskit-local" - }, - { - "title": "Install the Qiskit C API", - "url": "/docs/guides/install-c-api" - }, - { - "title": "Extend Qiskit in Python with C", - "url": "/docs/guides/c-extension-for-python" - }, - { - "title": "Online lab environments", - "url": "/docs/guides/online-lab-environments" - } - ] - }, - { - "title": "Circuits and operators", - "children": [ - { - "title": "Overview", - "url": "/docs/guides/construct-circuits" - }, - { - "title": "Circuit library", - "url": "/docs/guides/circuit-library" - }, - { - "title": "Save circuits to disk", - "url": "/docs/guides/save-circuits" - }, - { - "title": "Measure qubits", - "url": "/docs/guides/measure-qubits" - }, - { - "title": "Operators module", - "children": [ - { - "title": "Overview of operator classes", - "url": "/docs/guides/operators-overview" - }, - { - "title": "The Operator class", - "url": "/docs/guides/operator-class" - }, - { - "title": "Synthesize unitary operators", - "url": "/docs/guides/synthesize-unitary-operators" - }, - { - "title": "Specify observables in the Pauli basis", - "url": "/docs/guides/specify-observables-pauli" - } - ] - }, - { - "title": "Advanced circuit building", - "children": [ - { - "title": "Deferred timing resolution using stretch", - "url": "/docs/guides/stretch" - }, - { - "title": "Classical feedforward and control flow", - "url": "/docs/guides/classical-feedforward-and-control-flow" - }, - { - "title": "Bit-ordering in the Qiskit SDK", - "url": "/docs/guides/bit-ordering" - } - ] - }, - { - "title": "OpenQASM", - "children": [ - { - "title": "Intro to OpenQASM", - "url": "/docs/guides/introduction-to-qasm" - }, - { - "title": "OpenQASM 2 and the Qiskit SDK", - "url": "/docs/guides/interoperate-qiskit-qasm2" - }, - { - "title": "OpenQASM 3 and the Qiskit SDK", - "url": "/docs/guides/interoperate-qiskit-qasm3" - }, - { - "title": "OpenQASM 3 feature table", - "url": "/docs/guides/qasm-feature-table" - }, - { - "title": "OpenQASM 3.x live specification", - "url": "https://openqasm.com/" - } - ] - } - ] - }, - { - "title": "Transpilation", - "children": [ - { - "title": "Introduction to transpilation", - "url": "/docs/guides/transpile" - }, - { - "title": "Transpiler stages", - "url": "/docs/guides/transpiler-stages" - }, - { - "title": "Transpile with pass managers", - "url": "/docs/guides/transpile-with-pass-managers" - }, - { - "title": "Create a pass manager for dynamical decoupling", - "url": "/docs/guides/dynamical-decoupling-pass-manager" - }, - { - "title": "Configure preset pass managers", - "children": [ - { - "title": "Default settings and configuration options", - "url": "/docs/guides/defaults-and-configuration-options" - }, - { - "title": "Set optimization level", - "url": "/docs/guides/set-optimization" - }, - { - "title": "Commonly used parameters for transpilation", - "url": "/docs/guides/common-parameters" - }, - { - "title": "Represent quantum computers for the transpiler", - "url": "/docs/guides/represent-quantum-computers" - } - ] - }, - { - "title": "Compare transpiler settings", - "url": "/docs/guides/circuit-transpilation-settings" - }, - { - "title": "Advanced transpilation resources", - "children": [ - { - "title": "Write a custom transpiler pass", - "url": "/docs/guides/custom-transpiler-pass" - }, - { - "title": "Create and transpile against custom backends", - "url": "/docs/guides/custom-backend" - }, - { - "title": "Install and use transpiler plugins", - "url": "/docs/guides/transpiler-plugins" - }, - { - "title": "Create a transpiler plugin", - "url": "/docs/guides/create-transpiler-plugin" - }, - { - "title": "Work with DAGs in transpiler passes", - "url": "/docs/guides/DAG-representation" - }, - { - "title": "AI-powered transpiler passes", - "url": "/docs/guides/ai-transpiler-passes" - } - ] - } - ] - }, - { - "title": "Primitives", - "children": [ - { - "title": "Introduction to primitives", - "url": "/docs/guides/primitives" - }, - { - "title": "Primitive inputs and outputs", - "url": "/docs/guides/primitive-input-output" - }, - { - "title": "Get started with the backend primitives", - "url": "/docs/guides/get-started-with-backend-primitives" - }, - { - "title": "Exact simulation with Qiskit SDK primitives", - "url": "/docs/guides/simulate-with-qiskit-sdk-primitives" - } - ] - }, - { - "title": "Debugging", - "children": [ - { - "title": "Simulate circuits with noise", - "children": [ - { - "title": "Introduction", - "url": "/docs/guides/debugging-tools" - }, - { - "title": "Exact and noisy simulation with Qiskit Aer primitives", - "url": "/docs/guides/simulate-with-qiskit-aer" - }, - { - "title": "Exact simulation with Qiskit SDK primitives", - "url": "/docs/guides/simulate-with-qiskit-sdk-primitives" - }, - { - "title": "Build noise models", - "url": "/docs/guides/build-noise-models" - }, - { - "title": "Efficient simulation of stabilizer circuits with Qiskit Aer primitives", - "url": "/docs/guides/simulate-stabilizer-circuits" - } - ] - }, - { - "title": "Visualization", - "children": [ - { - "title": "Visualize circuits", - "url": "/docs/guides/visualize-circuits" - }, - { - "title": "Visualize circuit timing", - "url": "/docs/guides/visualize-circuit-timing" - }, - { - "title": "Plot quantum states", - "url": "/docs/guides/plot-quantum-states" - }, - { - "title": "Visualize results", - "url": "/docs/guides/visualize-results" - } - ] - } - ] - }, - { - "title": "Advanced techniques - Qiskit addons", - "url": "/docs/guides/addons" + "title": "IBM Quantum Compute service", + "url": "/docs/ibm-quantum-compute" }, { - "title": "Integrate external quantum resources with Qiskit", - "url": "/docs/guides/create-a-provider" - }, - { - "title": "Integrations", - "children": [ - { - "title": "Quantum resource management interface (QRMI)", - "url": "/docs/guides/qrmi" - }, - { - "title": "SPANK plugin for QRMI", - "url": "/docs/guides/slurm-plugin" - }, - { - "title": "SPANK plugin user guide", - "url": "/docs/guides/slurm-hpc-ux" - }, - { - "title": "Qiskit MCP servers", - "url": "/docs/guides/qiskit-mcp-servers" - } - ] - }, - { - "title": "Qiskit Code Assistant", - "url": "/docs/guides/qiskit-code-assistant" + "title": "IBM Quantum Platform", + "url": "/docs/ibm-quantum-platform" } ], "collapsible": false }, { - "title": "IBM Quantum services", + "title": "Algorithm research tools", "children": [ { - "title": "Introduction to IBM Quantum services", - "url": "/docs/guides/compute-services" - }, - { - "title": "Install", - "children": [ - { - "title": "Install the IBM Quantum Compute client", - "url": "/docs/guides/install-qiskit-runtime" - }, - { - "title": "Install the IBM Quantum Compute client from source", - "url": "/docs/guides/install-qiskit-runtime-source" - } - ] - }, - { - "title": "Run your first circuit on hardware", - "url": "/docs/guides/hello-world" - }, - { - "title": "IBM Quantum Platform", - "children": [ - { - "title": "Set up IBM Quantum Platform", - "children": [ - { - "title": "Set up your IBM Cloud account", - "url": "/docs/guides/cloud-setup" - }, - { - "title": "Set up your IBM Cloud account - invited users", - "url": "/docs/guides/cloud-setup-invited", - "platform": "cloud" - }, - { - "title": "Set up your IBM Cloud account in an untrusted environment", - "url": "/docs/guides/cloud-setup-untrusted", - "platform": "cloud" - }, - { - "title": "Set up to use IBM Quantum Platform with REST API", - "url": "/docs/guides/cloud-setup-rest-api", - "platform": "cloud" - }, - { - "title": "Save your login credentials", - "url": "/docs/guides/save-credentials", - "platform": "cloud" - }, - { - "title": "Initialize your IBM Quantum Compute Service account", - "url": "/docs/guides/initialize-account", - "platform": "cloud" - }, - { - "title": "Create a Classroom Account", - "url": "/docs/guides/classroom-accounts" - }, - { - "title": "Set up for an organization", - "children": [ - { - "title": "Setup considerations", - "url": "/docs/guides/considerations-set-up-runtime" - }, - { - "title": "Configure IBM Quantum Platform", - "url": "/docs/guides/quickstart-steps-org" - } - ] - } - ] - }, - { - "title": "IBM Quantum plans", - "children": [ - { - "title": "Plans overview", - "url": "/docs/guides/plans-overview" - }, - { - "title": "Upgrade from the Open Plan", - "url": "/docs/guides/upgrade-from-open" - }, - { - "title": "Manage cost on the Pay-As-You-Go Plan", - "url": "/docs/guides/manage-cost" - } - ] - }, - { - "title": "Work with instances", - "children": [ - { - "title": "Create and manage instances", - "url": "/docs/guides/instances" - }, - { - "title": "Set allocation limits", - "url": "/docs/guides/allocation-limits" - }, - { - "title": "Use IBM Cloud Resource Controller API to manage instances", - "url": "/docs/guides/access-instances-platform-apis" - } - ] - }, - { - "title": "Accounts, access groups, and policies", - "children": [ - { - "title": "Cloud account structure", - "url": "/docs/guides/cloud-account-structure" - }, - { - "title": "Create access groups and policies", - "url": "/docs/guides/access-groups" - }, - { - "title": "Set up custom roles", - "url": "/docs/guides/custom-roles" - } - ] - }, - { - "title": "Manage users", - "children": [ - { - "title": "Invite users and manage access", - "url": "/docs/guides/invite-and-manage-users" - }, - { - "title": "Manage ID provider users", - "url": "/docs/guides/manage-appid" - }, - { - "title": "Manage IBM Cloud users", - "url": "/docs/guides/manage-cloud-users" - } - ] - }, - { - "title": "Logging", - "url": "/docs/guides/logging" - } - ] + "title": "Qiskit SDK", + "url": "/docs/qiskit" }, { - "title": "Execute with primitives", + "title": "Noise management", "children": [ { - "title": "Introduction to IBM Quantum primitives", - "url": "/docs/guides/qiskit-runtime-primitives" - }, - { - "title": "Directed execution model (beta)", - "url": "/docs/guides/directed-execution-model" + "title": "Noise learning", + "url": "/docs/addons/qiskit-addon-paulice" }, { - "title": "Introduction to options", - "url": "/docs/guides/runtime-options-overview" - }, - { - "title": "Estimator", + "title": "Expectation values", "children": [ { - "title": "Get started", - "url": "/docs/guides/get-started-with-estimator" - }, - { - "title": "Inputs and outputs", - "url": "/docs/guides/estimator-input-output" - }, - { - "title": "Options", - "url": "/docs/guides/estimator-options" - }, - { - "title": "Configure noise management", - "url": "/docs/guides/estimator-noise-management" + "title": "PEC with shaded lightcones", + "url": "/docs/addons/qiskit-addon-slc" }, { - "title": "Examples", - "url": "/docs/guides/estimator-examples" + "title": "Propagated noise absorption", + "url": "/docs/addons/qiskit-addon-pna" }, { - "title": "REST API", - "url": "/docs/guides/estimator-rest-api" + "title": "Operator backpropagation", + "url": "/docs/addons/qiskit-addon-obp" } ] }, { - "title": "Sampler", + "title": "Sampling results", "children": [ { - "title": "Get started", - "url": "/docs/guides/get-started-with-sampler" - }, - { - "title": "Inputs and outputs", - "url": "/docs/guides/sampler-input-output" + "title": "Qiskit mitigation", + "url": "/docs/addons/qiskit-addon-obp" }, { - "title": "Options", - "url": "/docs/guides/sampler-options" + "title": "Matrix free measurement mitigation", + "url": "/docs/addons/qiskit-addon-obp" }, { - "title": "Configure noise management", - "url": "/docs/guides/sampler-noise-management" - }, - { - "title": "Examples", - "url": "/docs/guides/sampler-examples" - }, - { - "title": "REST API", - "url": "/docs/guides/sampler-rest-api" + "title": "Qiskit paulice", + "url": "/docs/addons/qiskit-addon-paulice" } ] - }, - { - "title": "Executor", - "children": [ - { - "title": "Get started", - "url": "/docs/guides/get-started-with-executor" - }, - { - "title": "Inputs and outputs", - "url": "/docs/guides/executor-input-output" - }, - { - "title": "Broadcasting", - "url": "/docs/guides/executor-broadcasting" - }, - { - "title": "Options", - "url": "/docs/guides/executor-options" - }, - { - "title": "Examples", - "url": "/docs/guides/executor-examples" - } - ] - }, - { - "title": "Manage noise", - "children": [ - { - "title": "Overview of noise management techniques", - "url": "/docs/guides/error-mitigation-overview" - }, - { - "title": "Error mitigation and suppression", - "url": "/docs/guides/error-mitigation-and-suppression-techniques" - }, - { - "title": "Noise learning", - "url": "/docs/guides/noise-learning" - }, - { - "title": "Use postselection in workloads", - "url": "/docs/guides/post-selection" - } - ] - }, - { - "title": "Debug jobs with NEAT", - "url": "/docs/guides/debug-qiskit-runtime-jobs" - }, - { - "title": "Local testing mode", - "url": "/docs/guides/local-testing-mode" } ] }, { - "title": "Advanced execution features", + "title": "Hamiltonian simulation", "children": [ { - "title": "Fractional gates", - "url": "/docs/guides/fractional-gates" + "title": "Qiskit fermions", + "url": "/docs/addons/qiskit-addon-obp" }, { - "title": "Execute dynamic circuits", - "url": "/docs/guides/execute-dynamic-circuits" + "title": "Approximate quantum compilation", + "url": "/docs/addons/qiskit-addon-obp" }, { - "title": "Visualize circuit timing", - "url": "/docs/guides/qiskit-runtime-circuit-timing" - } - ] - }, - { - "title": "IBM quantum computers", - "children": [ - { - "title": "Processor types", - "url": "/docs/guides/processor-types" - }, - { - "title": "View backend details", - "url": "/docs/guides/qpu-information" - }, - { - "title": "Monitoring, calibrations, and benchmarking", - "url": "/docs/guides/calibration-jobs" - }, - { - "title": "Qubit initialization", - "url": "/docs/guides/repetition-rate-execution" - }, - { - "title": "Retired cloud QPUs", - "url": "/docs/guides/retired-qpus" - }, - { - "title": "Fair-share scheduler", - "url": "/docs/guides/fair-share-scheduler" - }, - { - "title": "View cost", - "url": "/docs/guides/view-cost" - } - ] - }, - { - "title": "Manage workload execution", - "children": [ - { - "title": "Monitor or cancel a job", - "url": "/docs/guides/monitor-job" - }, - { - "title": "Workload usage", - "url": "/docs/guides/estimate-job-run-time" - }, - { - "title": "Minimize job run time", - "url": "/docs/guides/minimize-time" - }, - { - "title": "Maximum execution time", - "url": "/docs/guides/max-execution-time" - }, - { - "title": "Job limits", - "url": "/docs/guides/job-limits" + "title": "Multi-product formulas", + "url": "/docs/addons/qiskit-addon-obp" }, { - "title": "Organize and search by job tags", - "url": "/docs/guides/add-job-tags" + "title": "Sample-based quantum diagonalization", + "url": "/docs/addons/qiskit-addon-sqd" }, { - "title": "Retrieve and save job results", - "url": "/docs/guides/save-jobs" + "title": "ffsim", + "url": "/docs/addons/qiskit-addon-obp" } ] }, { - "title": "Execution modes", - "children": [ - { - "title": "Introduction to execution modes", - "url": "/docs/guides/execution-modes" - }, - { - "title": "Choose the right execution mode", - "url": "/docs/guides/choose-execution-mode" - }, - { - "title": "Run jobs in a batch", - "url": "/docs/guides/run-jobs-batch" - }, - { - "title": "Run jobs in a session", - "url": "/docs/guides/run-jobs-session" - }, - { - "title": "Execution modes using REST API", - "url": "/docs/guides/execution-modes-rest-api" - }, - { - "title": "Execution modes FAQ", - "url": "/docs/guides/execution-modes-faq" - } - ] + "title": "Optimization modeling", + "url": "/docs/addons/qiskit-addon-obp" }, { - "title": "Qiskit Serverless", + "title": "Supporting capabilities", "children": [ { - "title": "Introduction to Qiskit Serverless", - "url": "/docs/guides/serverless" + "title": "Qiskit addon utilities", + "url": "/docs/api/qiskit-addon-utils" }, { - "title": "Write your first Qiskit Serverless program", - "url": "/docs/guides/serverless-first-program" - }, - { - "title": "Run your first Qiskit Serverless workload remotely", - "url": "/docs/guides/serverless-run-first-workload" - }, - { - "title": "Manage Qiskit Serverless compute and data resources", - "url": "/docs/guides/serverless-manage-resources" - }, - { - "title": "Port code to Qiskit Serverless", - "url": "/docs/guides/serverless-port-code" + "title": "Pauli propagation", + "url": "/docs/api/qiskit-addon-utils" } ] } @@ -782,252 +167,30 @@ "children": [ { "title": "Introduction to Qiskit Functions", - "url": "/docs/guides/functions" - }, - { - "title": "Get started with Qiskit Functions", - "url": "/docs/guides/functions-get-started" + "url": "/docs/applications-research-tools" }, { - "title": "Circuit functions", - "children": [ - { - "title": "Algorithmiq Tensor-network error mitigation", - "url": "/docs/guides/algorithmiq-tem" - }, - { - "title": "Q-CTRL Performance Management", - "url": "/docs/guides/q-ctrl-performance-management" - }, - { - "title": "Qedma QESEM", - "url": "/docs/guides/qedma-qesem" - }, - { - "title": "Quantum Elements Orbit", - "url": "/docs/guides/quantum-elements-orbit", - "isNew": true, - "isNewDate": "2026-07-22" - } - ] + "title": "Domain functions", + "url": "/docs/applications-research-tools/kipu-optimization" }, { - "title": "Application functions", - "children": [ - { - "title": "Kipu Quantum Iskay Quantum Optimizer", - "url": "/docs/guides/kipu-optimization" - }, - { - "title": "Multiverse Computing Singularity", - "url": "/docs/guides/multiverse-computing-singularity" - }, - { - "title": "Q-CTRL Optimization Solver", - "url": "/docs/guides/q-ctrl-optimization-solver" - }, - { - "title": "Quantum Portfolio Optimizer: A Qiskit Function by Global Data Quantum", - "url": "/docs/guides/global-data-quantum-optimizer" - }, - { - "title": "QUICK-PDE: A Qiskit Function by ColibriTD", - "url": "/docs/guides/colibritd-pde" - }, - { - "title": "Qunova Computing HI-VQE Chemistry", - "url": "/docs/guides/qunova-chemistry" - } - ] + "title": "Circuit performance", + "url": "/docs/applications-research-tools/algorithmiq-tem" }, { "title": "Qiskit Function templates", - "children": [ - { - "title": "Introduction to Qiskit Function templates", - "url": "/docs/guides/qiskit-function-templates" - }, - { - "title": "Template for chemistry simulation", - "url": "/docs/guides/function-template-chemistry-workflow" - }, - { - "title": "Template for Hamiltonian simulation", - "url": "/docs/guides/function-template-hamiltonian-simulation" - } - ] + "url": "/docs/applications-research-tools/qiskit-function-templates" }, { - "title": "Sample-based quantum diagonalization (SQD)", - "url": "/docs/addons/qiskit-addon-sqd" + "title": "Qiskit serverless", + "url": "/docs/applications-research-tools/serverless" } ], "collapsible": false }, { "title": "Additional resources", - "collapsible": false, - "children": [ - { - "title": "Support and FAQ", - "children": [ - { - "title": "Support", - "url": "/docs/guides/support" - }, - { - "title": "Frequently-asked questions", - "url": "/docs/guides/faq" - } - ] - }, - { - "title": "Development workflow", - "url": "/docs/guides/intro-to-patterns" - }, - { - "title": "Migration guides", - "children": [ - { - "title": "Migrate to Qiskit 2.0", - "children": [ - { - "title": "Qiskit v2.0 migration guide", - "url": "/docs/guides/qiskit-2.0" - }, - { - "title": "Migrate from BackendV1 to BackendV2", - "url": "/docs/guides/qiskit-backendv1-to-v2" - } - ] - }, - { - "title": "Migrate to Qiskit 1.0", - "children": [ - { - "title": "Introduction", - "url": "/docs/guides/qiskit-1.0" - }, - { - "title": "Understand the breaking package changes", - "url": "/docs/guides/metapackage-migration" - }, - { - "title": "Install the new Qiskit v1.0 package", - "url": "/docs/guides/qiskit-1.0-installation" - }, - { - "title": "Qiskit v1.0 feature changes", - "url": "/docs/guides/qiskit-1.0-features" - } - ] - }, - { - "title": "Migrate from Sampler to Executor", - "url": "/docs/guides/migrate-from-sampler-to-executor", - "isNew": true, - "isNewDate": "2026-08-06" - }, - { - "title": "Migrate from Qiskit Pulse to fractional gates", - "url": "/docs/guides/pulse-migration" - }, - { - "title": "Migrate to local simulators", - "url": "/docs/guides/local-simulators" - } - ] - }, - { - "title": "Open-source resources", - "children": [ - { - "title": "Introduction", - "url": "/docs/guides/open-source" - }, - { - "title": "Code of conduct", - "url": "/docs/guides/code-of-conduct" - }, - { - "title": "Contributor license agreements", - "children": [ - { - "title": "Individual contributor", - "url": "/docs/open-source/qiskit-cla.pdf" - }, - { - "title": "Corporate contributor", - "url": "/docs/open-source/qiskit-corporate-cla.pdf" - } - ] - }, - { - "title": "Qiskit SDK", - "children": [ - { - "title": "Version strategy", - "url": "/docs/guides/qiskit-sdk-version-strategy" - }, - { - "title": "Contributor guide", - "url": "https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md" - }, - { - "title": "Maintainer guide", - "url": "https://github.com/Qiskit/qiskit/blob/main/MAINTAINING.md" - } - ] - }, - { - "title": "Qiskit ecosystem", - "url": "https://www.ibm.com/quantum/ecosystem" - } - ] - }, - { - "title": "Security and compliance", - "collapsed": true, - "children": [ - { - "title": "Securing your data", - "url": "/docs/guides/secure-data" - }, - { - "title": "Understanding your responsibilities when using IBM Quantum Compute Service", - "url": "/docs/guides/responsibilities" - }, - { - "title": "Use virtual private endpoints for VPC", - "url": "/docs/guides/virtual-private-endpoints" - }, - { - "title": "High availability and disaster recovery", - "url": "/docs/guides/ha-dr" - }, - { - "title": "Activity tracking events for IBM Quantum Compute Service", - "url": "/docs/guides/observability-runtime-rest" - }, - { - "title": "Activity tracking events for the IBM Quantum System service", - "url": "/docs/guides/observability-quantum-system" - }, - { - "title": "Authorization roles", - "url": "/docs/guides/authorization-roles" - }, - { - "title": "Repository security policies", - "url": "/docs/guides/security-policies" - }, - { - "title": "Protecting IBM Quantum Compute Service resources with context-based restrictions", - "url": "/docs/guides/context-based-restrictions" - } - ] - } - ] + "url": "/docs/additional-resources" } ] } diff --git a/docs/guides/cloud-setup-invited.mdx b/docs/guides/cloud-setup-invited.mdx deleted file mode 100644 index 4b75dcc5d9c..00000000000 --- a/docs/guides/cloud-setup-invited.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Set up your IBM Cloud account - invited users -description: Setup instructions for IBM Quantum on IBM Cloud to submit Qiskit SDK and IBM Quantum Compute jobs for users with email invitations ---- - -{/* cspell:ignore urlendcoded, WQVY */} - -# Set up your IBM Cloud account - invited users - -If you do not have an invitation from an administrator to join an account that an administrator set up, contact your administrator. If you need to set up your own account, follow the steps in [Set up your IBM Cloud account](/docs/guides/cloud-setup). - -You can run workloads on IBM® quantum processing units (QPUs) by setting up an account on IBM Cloud®. You will also need to [install and set up Qiskit and IBM Quantum Compute](/docs/guides/install-qiskit#local). - - -Your user account is associated with one or more [instances](/docs/guides/instances), identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API token (also called a key) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](/docs/guides/instances#connect-instance). - - - The [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com) and the [Instances page](https://quantum.cloud.ibm.com/instances) list the instances that you can access. - - - -## Set up to use IBM Cloud - -### Before you begin - -1. Accept the email invitation. -1. Log in with an IBMid or Google account. Note that the profile that you use to log in to IBM Cloud or IBM Quantum Platform in this step is not your IBM Cloud account. After logging in, confirm your information and accept the invitation to join the account. -1. Navigate back to [IBM Quantum Platform](https://quantum.cloud.ibm.com). -1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image. - * Choose the account that was invited in the email. - * The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to. - - ![The IBM Quantum Platform header is shown. The account switcher is to the right of the search bar. The region switcher is to the right of the account switcher.](/docs/images/guides/cloud-setup/IQP-Header.avif 'IBM Quantum Platform header') - - -### 2. Optional: Save your access credentials - -If you are using a trusted Python environment, such as a personal laptop, it is recommended that you use the `save_account()` method to [save your credentials locally](/docs/guides/save-credentials). - - -### 3. Connect Qiskit with your service instance - -- [Initialize the service](/docs/guides/initialize-account) in a **trusted Python environment** -- [Initialize the service in an **untrusted environment**](/docs/guides/cloud-setup-untrusted) (such as a public computer) - - - * Follow [these instructions](/docs/guides/cloud-setup-rest-api) if you want to connect by using the REST API instead of using Qiskit. - * If necessary, use [this information](/docs/guides/quickstart-steps-org#firewall) to configure your firewall to enable access to the IBM Quantum API endpoints. - - - -## Next steps - - - - [Overview of available plans](plans-overview). - - [Configure the Qiskit SDK locally](configure-qiskit-local). - - [Set up to use IBM Quantum Platform with REST API](/docs/guides/cloud-setup-rest-api). - - Follow the steps in the [Run your first circuit on hardware](/docs/guides/hello-world) guide to write and run a quantum program. - - Try a [tutorial](/docs/tutorials). - \ No newline at end of file diff --git a/docs/guides/cloud-setup.mdx b/docs/guides/cloud-setup.mdx deleted file mode 100644 index fbe18fcbd8e..00000000000 --- a/docs/guides/cloud-setup.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Set up your IBM Cloud account -description: Setup instructions for IBM Quantum on IBM Cloud to submit Qiskit SDK and IBM Quantum Compute Service jobs for users without email invitations ---- - -{/* cspell:ignore urlendcoded, WQVY */} - -# Set up your IBM Cloud account - -If you were emailed an invitation to join an account, follow the steps in [Set up your IBM Cloud account - invited users](/docs/guides/cloud-setup-invited) instead. - -You can run workloads on IBM® quantum processing units (QPUs) by setting up an account on IBM Cloud®. You will also need to [install and set up Qiskit and the IBM Quantum Compute client](/docs/guides/install-qiskit#local). - -Your user account is associated with one or more [instances](/docs/guides/instances) identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API token (also called a key) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](./instances#connect-instance). - - - -## Set up to use IBM Cloud - -### Before you begin - -1. If you do not already have one, set up an [IBM Cloud account](https://quantum.cloud.ibm.com/registration). - - You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](https://quantum.cloud.ibm.com) interface. - -1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.) -1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image. - - The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to. - - ![The IBM Quantum Platform header is shown. The account switcher is to the right of the search bar. The region switcher is to the right of the account switcher.](/docs/images/guides/cloud-setup/IQP-Header.avif 'IBM Quantum Platform header') - - -### 1. Create an instance - -You can create an instance from the IBM Quantum Platform [Instances](https://quantum.cloud.ibm.com/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions. - -### 2. Optional: Save your access credentials - -If you are using a trusted Python environment, such as a personal laptop, it is recommended that you use the `save_account()` method to [save your credentials locally](/docs/guides/save-credentials). - - -### 3. Connect Qiskit with your service instance - -- [Initialize the service](/docs/guides/initialize-account) in a **trusted Python environment** -- [Initialize the service in an **untrusted environment**](/docs/guides/cloud-setup-untrusted) (such as a public computer) - - - * Follow [these instructions](/docs/guides/cloud-setup-rest-api) if you want to connect by using the REST API instead of using Qiskit. - * If necessary, use [this information](/docs/guides/quickstart-steps-org#firewall) to configure your firewall to enable access to the IBM Quantum API endpoints. - - - -## Next steps - - - - [Overview of available plans](plans-overview). - - [Configure the Qiskit SDK locally](configure-qiskit-local). - - [View your available QPUs](/docs/guides/qpu-information#available). - - Follow the steps in the [Run your first circuit on hardware](/docs/guides/hello-world) guide to write and run a quantum program. - - [Set up to use IBM Quantum Platform with REST API](/docs/guides/cloud-setup-rest-api). - - Try a [tutorial](/docs/tutorials). - \ No newline at end of file diff --git a/docs/ibm-quantum-compute/_toc.json b/docs/ibm-quantum-compute/_toc.json new file mode 100644 index 00000000000..9f91219ecb7 --- /dev/null +++ b/docs/ibm-quantum-compute/_toc.json @@ -0,0 +1,314 @@ +{ + "parentUrl": "/docs/guides", + "parentLabel": "Documentation", + "title": "IBM Quantum Compute", + "collapsed": true, + "children": [ + { + "title": "Get started", + "children": [ + { + "title": "Introduction to IBM Quantum Compute service", + "url": "/docs/ibm-quantum-compute" + }, + { + "title": "Run your first circuit on hardware", + "url": "/docs/ibm-quantum-compute/hello-world" + }, + { + "title": "Authentication", + "url": "/docs/ibm-quantum-compute/authenticate-account" + } + ], + "collapsible": false + }, + { + "title": "Install and authenticate", + "children": [ + { + "title": "Install", + "children": [ + { + "title": "Install the IBM Quantum Compute client", + "url": "/docs/ibm-quantum-compute/install-qiskit-runtime" + }, + { + "title": "Install the IBM Quantum Compute client from source", + "url": "/docs/ibm-quantum-compute/install-qiskit-runtime-source" + } + ] + }, + { + "title": "Credential management", + "children": [ + { + "title": "Authenticate account in an untrusted environment", + "url": "/docs/ibm-quantum-compute/cloud-setup-untrusted", + "platform": "cloud" + }, + { + "title": "Authenticate to IBM Quantum Compute Service REST API", + "url": "/docs/ibm-quantum-compute/cloud-setup-rest-api", + "platform": "cloud" + }, + { + "title": "Save your login credentials", + "url": "/docs/ibm-quantum-compute/save-credentials", + "platform": "cloud" + } + ] + } + ], + "collapsible": false + }, + { + "title": "Primitives", + "children": [ + { + "title": "Introduction to IBM Quantum primitives", + "url": "/docs/ibm-quantum-compute/qiskit-runtime-primitives" + }, + { + "title": "Primitive options", + "url": "/docs/ibm-quantum-compute/runtime-options-overview" + }, + { + "title": "Directed execution model (beta)", + "url": "/docs/ibm-quantum-compute/directed-execution-model" + }, + { + "title": "Estimator", + "children": [ + { + "title": "Get started", + "url": "/docs/ibm-quantum-compute/get-started-with-estimator" + }, + { + "title": "Inputs and outputs", + "url": "/docs/ibm-quantum-compute/estimator-input-output" + }, + { + "title": "Options", + "url": "/docs/ibm-quantum-compute/estimator-options" + }, + { + "title": "Configure noise management", + "url": "/docs/ibm-quantum-compute/estimator-noise-management" + }, + { + "title": "Examples", + "url": "/docs/ibm-quantum-compute/estimator-examples" + }, + { + "title": "REST API", + "url": "/docs/ibm-quantum-compute/estimator-rest-api" + } + ] + }, + { + "title": "Sampler", + "children": [ + { + "title": "Get started", + "url": "/docs/ibm-quantum-compute/get-started-with-sampler" + }, + { + "title": "Inputs and outputs", + "url": "/docs/ibm-quantum-compute/sampler-input-output" + }, + { + "title": "Options", + "url": "/docs/ibm-quantum-compute/sampler-options" + }, + { + "title": "Configure noise management", + "url": "/docs/ibm-quantum-compute/sampler-noise-management" + }, + { + "title": "Examples", + "url": "/docs/ibm-quantum-compute/sampler-examples" + }, + { + "title": "REST API", + "url": "/docs/ibm-quantum-compute/sampler-rest-api" + } + ] + }, + { + "title": "Executor", + "children": [ + { + "title": "Get started", + "url": "/docs/ibm-quantum-compute/get-started-with-executor" + }, + { + "title": "Inputs and outputs", + "url": "/docs/ibm-quantum-compute/executor-input-output" + }, + { + "title": "Broadcasting", + "url": "/docs/ibm-quantum-compute/executor-broadcasting" + }, + { + "title": "Options", + "url": "/docs/ibm-quantum-compute/executor-options" + }, + { + "title": "Examples", + "url": "/docs/ibm-quantum-compute/executor-examples" + } + ] + }, + { + "title": "Advanced execution features", + "children": [ + { + "title": "Fractional gates", + "url": "/docs/ibm-quantum-compute/fractional-gates" + }, + { + "title": "Execute dynamic circuits", + "url": "/docs/ibm-quantum-compute/execute-dynamic-circuits" + }, + { + "title": "Visualize circuit timing", + "url": "/docs/ibm-quantum-compute/qiskit-runtime-circuit-timing" + } + ] + }, + { + "title": "Debug jobs with NEAT", + "url": "/docs/ibm-quantum-compute/debug-qiskit-runtime-jobs" + }, + { + "title": "Local testing mode", + "url": "/docs/ibm-quantum-compute/local-testing-mode" + } + ], + "collapsible": false + }, + { + "title": "Error mitigation and noise management", + "children": [ + { + "title": "Overview", + "url": "/docs/ibm-quantum-compute/error-mitigation-overview" + }, + { + "title": "Error mitigation and suppression", + "url": "/docs/ibm-quantum-compute/error-mitigation-and-suppression-techniques" + }, + { + "title": "Noise learning", + "url": "/docs/ibm-quantum-compute/noise-learning" + }, + { + "title": "Use postselection", + "url": "/docs/ibm-quantum-compute/post-selection" + } + ], + "collapsible": false + }, + { + "title": "Workload execution", + "children": [ + { + "title": "Manage workload execution", + "children": [ + { + "title": "Monitor or cancel a job", + "url": "/docs/ibm-quantum-compute/monitor-job" + }, + { + "title": "Estimate job run time", + "url": "/docs/ibm-quantum-compute/estimate-job-run-time" + }, + { + "title": "Minimize job run time", + "url": "/docs/ibm-quantum-compute/minimize-time" + }, + { + "title": "Maximum execution time", + "url": "/docs/ibm-quantum-compute/max-execution-time" + }, + { + "title": "Job limits", + "url": "/docs/ibm-quantum-compute/job-limits" + }, + { + "title": "Organize and search by job tags", + "url": "/docs/ibm-quantum-compute/add-job-tags" + }, + { + "title": "Retrieve and save job results", + "url": "/docs/ibm-quantum-compute/save-jobs" + } + ] + }, + { + "title": "Execution modes", + "children": [ + { + "title": "Introduction to execution modes", + "url": "/docs/ibm-quantum-compute/execution-modes" + }, + { + "title": "Choose the right execution mode", + "url": "/docs/ibm-quantum-compute/choose-execution-mode" + }, + { + "title": "Run jobs in a batch", + "url": "/docs/ibm-quantum-compute/run-jobs-batch" + }, + { + "title": "Run jobs in a session", + "url": "/docs/ibm-quantum-compute/run-jobs-session" + }, + { + "title": "Execution modes using REST API", + "url": "/docs/ibm-quantum-compute/execution-modes-rest-api" + }, + { + "title": "Execution modes FAQ", + "url": "/docs/ibm-quantum-compute/execution-modes-faq" + } + ] + } + ], + "collapsible": false + }, + { + "title": "IBM Quantum computers", + "children": [ + { + "title": "Processor types", + "url": "/docs/ibm-quantum-compute/processor-types" + }, + { + "title": "View backend details", + "url": "/docs/ibm-quantum-compute/qpu-information" + }, + { + "title": "Monitoring, calibrations, and benchmarking", + "url": "/docs/ibm-quantum-compute/calibration-jobs" + }, + { + "title": "Qubit initialization", + "url": "/docs/ibm-quantum-compute/repetition-rate-execution" + }, + { + "title": "Retired cloud QPUs", + "url": "/docs/ibm-quantum-compute/retired-qpus" + }, + { + "title": "Fair-share scheduler", + "url": "/docs/ibm-quantum-compute/fair-share-scheduler" + }, + { + "title": "View cost", + "url": "/docs/ibm-quantum-compute/view-cost" + } + ] + } + ] +} diff --git a/docs/guides/add-job-tags.ipynb b/docs/ibm-quantum-compute/add-job-tags.ipynb similarity index 100% rename from docs/guides/add-job-tags.ipynb rename to docs/ibm-quantum-compute/add-job-tags.ipynb diff --git a/docs/guides/initialize-account.mdx b/docs/ibm-quantum-compute/authenticate-account.mdx similarity index 97% rename from docs/guides/initialize-account.mdx rename to docs/ibm-quantum-compute/authenticate-account.mdx index 277de56eaf8..55f446513d9 100644 --- a/docs/guides/initialize-account.mdx +++ b/docs/ibm-quantum-compute/authenticate-account.mdx @@ -4,9 +4,9 @@ description: How to initialize your IBM Quantum Compute Service account, instant --- -# Initialize your IBM Quantum Compute Service account +# Authenticate your IBM Quantum Compute Service account -Before using the IBM Quantum® Compute Service, you have to initialize (instantiate) your account by submitting (loading) credentials. These credentials can be manually submitted each time you initialize IBM Quantum Compute Service, or you can save them for reuse. +Before using the IBM Quantum® Compute Service, you have to authenticate your account by submitting (loading) credentials. These credentials can be manually submitted each time you initialize IBM Quantum Compute Service, or you can save them for reuse. * If you are using a public computer or other untrusted environment, follow the instructions in [Initialize the service in an untrusted environment](/docs/guides/cloud-setup-untrusted) instead. diff --git a/docs/guides/calibration-jobs.mdx b/docs/ibm-quantum-compute/calibration-jobs.mdx similarity index 100% rename from docs/guides/calibration-jobs.mdx rename to docs/ibm-quantum-compute/calibration-jobs.mdx diff --git a/docs/guides/choose-execution-mode.mdx b/docs/ibm-quantum-compute/choose-execution-mode.mdx similarity index 100% rename from docs/guides/choose-execution-mode.mdx rename to docs/ibm-quantum-compute/choose-execution-mode.mdx diff --git a/docs/guides/cloud-setup-rest-api.mdx b/docs/ibm-quantum-compute/cloud-setup-rest-api.mdx similarity index 100% rename from docs/guides/cloud-setup-rest-api.mdx rename to docs/ibm-quantum-compute/cloud-setup-rest-api.mdx diff --git a/docs/guides/cloud-setup-untrusted.mdx b/docs/ibm-quantum-compute/cloud-setup-untrusted.mdx similarity index 100% rename from docs/guides/cloud-setup-untrusted.mdx rename to docs/ibm-quantum-compute/cloud-setup-untrusted.mdx diff --git a/docs/guides/debug-qiskit-runtime-jobs.ipynb b/docs/ibm-quantum-compute/debug-qiskit-runtime-jobs.ipynb similarity index 100% rename from docs/guides/debug-qiskit-runtime-jobs.ipynb rename to docs/ibm-quantum-compute/debug-qiskit-runtime-jobs.ipynb diff --git a/docs/guides/directed-execution-model.mdx b/docs/ibm-quantum-compute/directed-execution-model.mdx similarity index 100% rename from docs/guides/directed-execution-model.mdx rename to docs/ibm-quantum-compute/directed-execution-model.mdx diff --git a/docs/guides/error-mitigation-and-suppression-techniques.ipynb b/docs/ibm-quantum-compute/error-mitigation-and-suppression-techniques.ipynb similarity index 100% rename from docs/guides/error-mitigation-and-suppression-techniques.ipynb rename to docs/ibm-quantum-compute/error-mitigation-and-suppression-techniques.ipynb diff --git a/docs/guides/error-mitigation-overview.mdx b/docs/ibm-quantum-compute/error-mitigation-overview.mdx similarity index 100% rename from docs/guides/error-mitigation-overview.mdx rename to docs/ibm-quantum-compute/error-mitigation-overview.mdx diff --git a/docs/guides/estimate-job-run-time.ipynb b/docs/ibm-quantum-compute/estimate-job-run-time.ipynb similarity index 100% rename from docs/guides/estimate-job-run-time.ipynb rename to docs/ibm-quantum-compute/estimate-job-run-time.ipynb diff --git a/docs/guides/estimator-examples.ipynb b/docs/ibm-quantum-compute/estimator-examples.ipynb similarity index 100% rename from docs/guides/estimator-examples.ipynb rename to docs/ibm-quantum-compute/estimator-examples.ipynb diff --git a/docs/guides/estimator-input-output.ipynb b/docs/ibm-quantum-compute/estimator-input-output.ipynb similarity index 100% rename from docs/guides/estimator-input-output.ipynb rename to docs/ibm-quantum-compute/estimator-input-output.ipynb diff --git a/docs/guides/estimator-noise-management.ipynb b/docs/ibm-quantum-compute/estimator-noise-management.ipynb similarity index 100% rename from docs/guides/estimator-noise-management.ipynb rename to docs/ibm-quantum-compute/estimator-noise-management.ipynb diff --git a/docs/guides/estimator-options.ipynb b/docs/ibm-quantum-compute/estimator-options.ipynb similarity index 100% rename from docs/guides/estimator-options.ipynb rename to docs/ibm-quantum-compute/estimator-options.ipynb diff --git a/docs/guides/estimator-rest-api.ipynb b/docs/ibm-quantum-compute/estimator-rest-api.ipynb similarity index 100% rename from docs/guides/estimator-rest-api.ipynb rename to docs/ibm-quantum-compute/estimator-rest-api.ipynb diff --git a/docs/guides/execute-dynamic-circuits.ipynb b/docs/ibm-quantum-compute/execute-dynamic-circuits.ipynb similarity index 100% rename from docs/guides/execute-dynamic-circuits.ipynb rename to docs/ibm-quantum-compute/execute-dynamic-circuits.ipynb diff --git a/docs/guides/execution-modes-faq.mdx b/docs/ibm-quantum-compute/execution-modes-faq.mdx similarity index 100% rename from docs/guides/execution-modes-faq.mdx rename to docs/ibm-quantum-compute/execution-modes-faq.mdx diff --git a/docs/guides/execution-modes-rest-api.ipynb b/docs/ibm-quantum-compute/execution-modes-rest-api.ipynb similarity index 100% rename from docs/guides/execution-modes-rest-api.ipynb rename to docs/ibm-quantum-compute/execution-modes-rest-api.ipynb diff --git a/docs/guides/execution-modes.mdx b/docs/ibm-quantum-compute/execution-modes.mdx similarity index 100% rename from docs/guides/execution-modes.mdx rename to docs/ibm-quantum-compute/execution-modes.mdx diff --git a/docs/guides/executor-broadcasting.mdx b/docs/ibm-quantum-compute/executor-broadcasting.mdx similarity index 100% rename from docs/guides/executor-broadcasting.mdx rename to docs/ibm-quantum-compute/executor-broadcasting.mdx diff --git a/docs/guides/executor-examples.ipynb b/docs/ibm-quantum-compute/executor-examples.ipynb similarity index 100% rename from docs/guides/executor-examples.ipynb rename to docs/ibm-quantum-compute/executor-examples.ipynb diff --git a/docs/guides/executor-input-output.ipynb b/docs/ibm-quantum-compute/executor-input-output.ipynb similarity index 100% rename from docs/guides/executor-input-output.ipynb rename to docs/ibm-quantum-compute/executor-input-output.ipynb diff --git a/docs/guides/executor-options.ipynb b/docs/ibm-quantum-compute/executor-options.ipynb similarity index 100% rename from docs/guides/executor-options.ipynb rename to docs/ibm-quantum-compute/executor-options.ipynb diff --git a/docs/guides/fair-share-scheduler.mdx b/docs/ibm-quantum-compute/fair-share-scheduler.mdx similarity index 100% rename from docs/guides/fair-share-scheduler.mdx rename to docs/ibm-quantum-compute/fair-share-scheduler.mdx diff --git a/docs/guides/fractional-gates.ipynb b/docs/ibm-quantum-compute/fractional-gates.ipynb similarity index 100% rename from docs/guides/fractional-gates.ipynb rename to docs/ibm-quantum-compute/fractional-gates.ipynb diff --git a/docs/guides/get-started-with-estimator.ipynb b/docs/ibm-quantum-compute/get-started-with-estimator.ipynb similarity index 100% rename from docs/guides/get-started-with-estimator.ipynb rename to docs/ibm-quantum-compute/get-started-with-estimator.ipynb diff --git a/docs/guides/get-started-with-executor.ipynb b/docs/ibm-quantum-compute/get-started-with-executor.ipynb similarity index 100% rename from docs/guides/get-started-with-executor.ipynb rename to docs/ibm-quantum-compute/get-started-with-executor.ipynb diff --git a/docs/guides/get-started-with-sampler.ipynb b/docs/ibm-quantum-compute/get-started-with-sampler.ipynb similarity index 100% rename from docs/guides/get-started-with-sampler.ipynb rename to docs/ibm-quantum-compute/get-started-with-sampler.ipynb diff --git a/docs/guides/hello-world.ipynb b/docs/ibm-quantum-compute/hello-world.ipynb similarity index 100% rename from docs/guides/hello-world.ipynb rename to docs/ibm-quantum-compute/hello-world.ipynb diff --git a/docs/guides/compute-services.mdx b/docs/ibm-quantum-compute/index.mdx similarity index 80% rename from docs/guides/compute-services.mdx rename to docs/ibm-quantum-compute/index.mdx index 169900685e1..ee50f95e180 100644 --- a/docs/guides/compute-services.mdx +++ b/docs/ibm-quantum-compute/index.mdx @@ -1,5 +1,5 @@ --- -title: Introduction to IBM Quantum services +title: Introduction to IBM Quantum Compute Service description: Introduction to IBM Quantum Compute Service, Qiskit Functions, Qiskit Serverless, and IBM Quantum Platform --- @@ -26,15 +26,6 @@ See the [installation page](/docs/guides/install-qiskit) to set up a development ### Is Quantum Compute open-source? The short answer is, _not all of it_. The software that handles the technicalities of running your quantum program on an IBM Quantum device (including any error mitigation and suppression) is **not** open-source. However, the client software library `qiskit-ibm-runtime` (which is the interface for users to access IBM Quantum Compute Service), the Qiskit SDK running on the server side, and some of the software used for error mitigation, **are** open-source. To get involved with Qiskit open-source efforts, visit our GitHub organization at [github.com/Qiskit](https://github.com/Qiskit) and [github.com/Qiskit-Extensions](https://github.com/Qiskit-Extensions/). -## IBM Quantum Platform - -IBM Quantum Platform provides a unified environment for managing users and organizations, configuring access plans, viewing and organizing workloads submitted to Quantum Compute, and monitoring system activity. Designed to support teams ranging from individual researchers to enterprise-scale programs, the platform centralizes access to the IBM fleet of quantum processing units (QPUs) and associated services. Administrators can manage memberships and permissions, configure entitlements, and oversee usage, while developers benefit from a consistent interface for interacting with quantum systems. - -To run quantum jobs, users create an [instance](/docs/guides/instances) within the platform. Each instance provides its own Cloud Resource Name (CRN), which is required for submitting workloads to available QPUs. Once configured, users can select or adjust access plans, track job execution, analyze logs, and integrate the platform seamlessly into their development workflows. Together, these capabilities make IBM Quantum Platform the control center for QPU access and quantum application execution. - -For more details, read the [setup documentation](/docs/guides/cloud-setup) for getting started with IBM Quantum Platform. - - ## Qiskit Serverless Creating utility-scale quantum applications generally requires a variety of compute resource requirements. Qiskit Serverless (`qiskit-ibm-catalog.QiskitServerless`) provides a simple interface to run workloads across quantum-classical resources. This includes deploying programs to IBM Quantum Platform and running workloads remotely, as well as easy resource management for multi-cloud and quantum-centric supercomputing use cases. See more information in the [Qiskit Serverless documentation](/docs/guides/serverless) about how to use this collection of tools to: diff --git a/docs/guides/install-qiskit-runtime-source.mdx b/docs/ibm-quantum-compute/install-qiskit-runtime-source.mdx similarity index 100% rename from docs/guides/install-qiskit-runtime-source.mdx rename to docs/ibm-quantum-compute/install-qiskit-runtime-source.mdx diff --git a/docs/guides/install-qiskit-runtime.mdx b/docs/ibm-quantum-compute/install-qiskit-runtime.mdx similarity index 100% rename from docs/guides/install-qiskit-runtime.mdx rename to docs/ibm-quantum-compute/install-qiskit-runtime.mdx diff --git a/docs/guides/job-limits.mdx b/docs/ibm-quantum-compute/job-limits.mdx similarity index 100% rename from docs/guides/job-limits.mdx rename to docs/ibm-quantum-compute/job-limits.mdx diff --git a/docs/guides/local-testing-mode.ipynb b/docs/ibm-quantum-compute/local-testing-mode.ipynb similarity index 100% rename from docs/guides/local-testing-mode.ipynb rename to docs/ibm-quantum-compute/local-testing-mode.ipynb diff --git a/docs/guides/max-execution-time.ipynb b/docs/ibm-quantum-compute/max-execution-time.ipynb similarity index 100% rename from docs/guides/max-execution-time.ipynb rename to docs/ibm-quantum-compute/max-execution-time.ipynb diff --git a/docs/guides/minimize-time.mdx b/docs/ibm-quantum-compute/minimize-time.mdx similarity index 100% rename from docs/guides/minimize-time.mdx rename to docs/ibm-quantum-compute/minimize-time.mdx diff --git a/docs/guides/monitor-job.ipynb b/docs/ibm-quantum-compute/monitor-job.ipynb similarity index 100% rename from docs/guides/monitor-job.ipynb rename to docs/ibm-quantum-compute/monitor-job.ipynb diff --git a/docs/guides/noise-learning.ipynb b/docs/ibm-quantum-compute/noise-learning.ipynb similarity index 100% rename from docs/guides/noise-learning.ipynb rename to docs/ibm-quantum-compute/noise-learning.ipynb diff --git a/docs/guides/post-selection.ipynb b/docs/ibm-quantum-compute/post-selection.ipynb similarity index 100% rename from docs/guides/post-selection.ipynb rename to docs/ibm-quantum-compute/post-selection.ipynb diff --git a/docs/guides/processor-types.mdx b/docs/ibm-quantum-compute/processor-types.mdx similarity index 100% rename from docs/guides/processor-types.mdx rename to docs/ibm-quantum-compute/processor-types.mdx diff --git a/docs/guides/qiskit-runtime-circuit-timing.ipynb b/docs/ibm-quantum-compute/qiskit-runtime-circuit-timing.ipynb similarity index 100% rename from docs/guides/qiskit-runtime-circuit-timing.ipynb rename to docs/ibm-quantum-compute/qiskit-runtime-circuit-timing.ipynb diff --git a/docs/guides/qiskit-runtime-primitives.mdx b/docs/ibm-quantum-compute/qiskit-runtime-primitives.mdx similarity index 100% rename from docs/guides/qiskit-runtime-primitives.mdx rename to docs/ibm-quantum-compute/qiskit-runtime-primitives.mdx diff --git a/docs/guides/qpu-information.ipynb b/docs/ibm-quantum-compute/qpu-information.ipynb similarity index 100% rename from docs/guides/qpu-information.ipynb rename to docs/ibm-quantum-compute/qpu-information.ipynb diff --git a/docs/guides/repetition-rate-execution.ipynb b/docs/ibm-quantum-compute/repetition-rate-execution.ipynb similarity index 100% rename from docs/guides/repetition-rate-execution.ipynb rename to docs/ibm-quantum-compute/repetition-rate-execution.ipynb diff --git a/docs/guides/retired-qpus.ipynb b/docs/ibm-quantum-compute/retired-qpus.ipynb similarity index 100% rename from docs/guides/retired-qpus.ipynb rename to docs/ibm-quantum-compute/retired-qpus.ipynb diff --git a/docs/guides/run-jobs-batch.ipynb b/docs/ibm-quantum-compute/run-jobs-batch.ipynb similarity index 100% rename from docs/guides/run-jobs-batch.ipynb rename to docs/ibm-quantum-compute/run-jobs-batch.ipynb diff --git a/docs/guides/run-jobs-session.ipynb b/docs/ibm-quantum-compute/run-jobs-session.ipynb similarity index 100% rename from docs/guides/run-jobs-session.ipynb rename to docs/ibm-quantum-compute/run-jobs-session.ipynb diff --git a/docs/guides/runtime-options-overview.mdx b/docs/ibm-quantum-compute/runtime-options-overview.mdx similarity index 100% rename from docs/guides/runtime-options-overview.mdx rename to docs/ibm-quantum-compute/runtime-options-overview.mdx diff --git a/docs/guides/sampler-examples.ipynb b/docs/ibm-quantum-compute/sampler-examples.ipynb similarity index 100% rename from docs/guides/sampler-examples.ipynb rename to docs/ibm-quantum-compute/sampler-examples.ipynb diff --git a/docs/guides/sampler-input-output.ipynb b/docs/ibm-quantum-compute/sampler-input-output.ipynb similarity index 100% rename from docs/guides/sampler-input-output.ipynb rename to docs/ibm-quantum-compute/sampler-input-output.ipynb diff --git a/docs/guides/sampler-noise-management.ipynb b/docs/ibm-quantum-compute/sampler-noise-management.ipynb similarity index 100% rename from docs/guides/sampler-noise-management.ipynb rename to docs/ibm-quantum-compute/sampler-noise-management.ipynb diff --git a/docs/guides/sampler-options.ipynb b/docs/ibm-quantum-compute/sampler-options.ipynb similarity index 100% rename from docs/guides/sampler-options.ipynb rename to docs/ibm-quantum-compute/sampler-options.ipynb diff --git a/docs/guides/sampler-rest-api.mdx b/docs/ibm-quantum-compute/sampler-rest-api.mdx similarity index 100% rename from docs/guides/sampler-rest-api.mdx rename to docs/ibm-quantum-compute/sampler-rest-api.mdx diff --git a/docs/guides/save-credentials.mdx b/docs/ibm-quantum-compute/save-credentials.mdx similarity index 100% rename from docs/guides/save-credentials.mdx rename to docs/ibm-quantum-compute/save-credentials.mdx diff --git a/docs/guides/save-jobs.ipynb b/docs/ibm-quantum-compute/save-jobs.ipynb similarity index 100% rename from docs/guides/save-jobs.ipynb rename to docs/ibm-quantum-compute/save-jobs.ipynb diff --git a/docs/guides/view-cost.mdx b/docs/ibm-quantum-compute/view-cost.mdx similarity index 100% rename from docs/guides/view-cost.mdx rename to docs/ibm-quantum-compute/view-cost.mdx diff --git a/docs/ibm-quantum-platform/_toc.json b/docs/ibm-quantum-platform/_toc.json new file mode 100644 index 00000000000..cbadbeb9cc5 --- /dev/null +++ b/docs/ibm-quantum-platform/_toc.json @@ -0,0 +1,116 @@ +{ + "parentUrl": "/docs/guides", + "parentLabel": "Documentation", + "title": "IBM Quantum Platform", + "collapsed": true, + "children": [ + { + "title": "Get started", + "children": [ + { + "title": "Introduction to IBM Quantum Platform", + "url": "/docs/ibm-quantum-platform" + }, + { + "title": "Set up your IBM Cloud account", + "url": "/docs/ibm-quantum-platform/cloud-setup" + }, + { + "title": "Create and manage instances", + "url": "/docs/ibm-quantum-platform/instances" + } + ], + "collapsible": false + }, + { + "title": "IBM Quantum plans", + "children": [ + { + "title": "Plans overview", + "url": "/docs/ibm-quantum-platform/plans-overview" + }, + { + "title": "Upgrade from the Open Plan", + "url": "/docs/ibm-quantum-platform/upgrade-from-open" + }, + { + "title": "Manage cost on the Pay-As-You-Go Plan", + "url": "/docs/ibm-quantum-platform/manage-cost" + } + ] + }, + { + "title": "Instance management", + "children": [ + { + "title": "Set allocation limits", + "url": "/docs/ibm-quantum-platform/allocation-limits" + }, + { + "title": "Use IBM Cloud Resource Controller API to manage instances", + "url": "/docs/ibm-quantum-platform/access-instances-platform-apis" + } + ] + }, + { + "title": "User and account administration", + "children": [ + { + "title": "Create a Classroom Account", + "url": "/docs/ibm-quantum-platform/classroom-accounts" + }, + { + "title": "Set up for an organization", + "children": [ + { + "title": "Setup considerations", + "url": "/docs/ibm-quantum-platform/considerations-set-up-runtime" + }, + { + "title": "Configure IBM Quantum Platform", + "url": "/docs/ibm-quantum-platform/quickstart-steps-org" + } + ] + }, + { + "title": "Accounts, access groups, and policies", + "children": [ + { + "title": "Cloud account structure", + "url": "/docs/ibm-quantum-platform/cloud-account-structure" + }, + { + "title": "Create access groups and policies", + "url": "/docs/ibm-quantum-platform/access-groups" + }, + { + "title": "Set up custom roles", + "url": "/docs/ibm-quantum-platform/custom-roles" + } + ] + }, + { + "title": "Manage users", + "children": [ + { + "title": "Invite users and manage access", + "url": "/docs/ibm-quantum-platform/invite-and-manage-users" + }, + { + "title": "Manage ID provider users", + "url": "/docs/ibm-quantum-platform/manage-appid" + }, + { + "title": "Manage IBM Cloud users", + "url": "/docs/ibm-quantum-platform/manage-cloud-users" + } + ] + } + ] + }, + { + "title": "Logging", + "url": "/docs/ibm-quantum-platform/logging" + } + ] +} diff --git a/docs/guides/access-groups.mdx b/docs/ibm-quantum-platform/access-groups.mdx similarity index 100% rename from docs/guides/access-groups.mdx rename to docs/ibm-quantum-platform/access-groups.mdx diff --git a/docs/guides/access-instances-platform-apis.mdx b/docs/ibm-quantum-platform/access-instances-platform-apis.mdx similarity index 100% rename from docs/guides/access-instances-platform-apis.mdx rename to docs/ibm-quantum-platform/access-instances-platform-apis.mdx diff --git a/docs/guides/allocation-limits.mdx b/docs/ibm-quantum-platform/allocation-limits.mdx similarity index 100% rename from docs/guides/allocation-limits.mdx rename to docs/ibm-quantum-platform/allocation-limits.mdx diff --git a/docs/guides/classroom-accounts.mdx b/docs/ibm-quantum-platform/classroom-accounts.mdx similarity index 100% rename from docs/guides/classroom-accounts.mdx rename to docs/ibm-quantum-platform/classroom-accounts.mdx diff --git a/docs/guides/cloud-account-structure.mdx b/docs/ibm-quantum-platform/cloud-account-structure.mdx similarity index 100% rename from docs/guides/cloud-account-structure.mdx rename to docs/ibm-quantum-platform/cloud-account-structure.mdx diff --git a/docs/ibm-quantum-platform/cloud-setup.mdx b/docs/ibm-quantum-platform/cloud-setup.mdx new file mode 100644 index 00000000000..ae0e12760ee --- /dev/null +++ b/docs/ibm-quantum-platform/cloud-setup.mdx @@ -0,0 +1,125 @@ +--- +title: Set up your IBM Cloud account +description: Setup instructions for IBM Quantum on IBM Cloud to submit Qiskit SDK and IBM Quantum Compute Service jobs for users without email invitations +--- + +{/* cspell:ignore urlendcoded, WQVY */} + +# Set up your IBM Cloud account + +You can run workloads on IBM® quantum processing units (QPUs) by setting up an account on IBM Cloud®. You will also need to [install and set up Qiskit and the IBM Quantum Compute client](/docs/guides/install-qiskit#local). + +Your user account is associated with one or more [instances](/docs/guides/instances) identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API key (also called an API _token_) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](./instances#connect-instance). + + +If you were emailed an invitation to join an account, follow the steps in [Set up your IBM Cloud account - invited users](#set-up-to-use-ibm-cloud---invited-users) instead. + +For users without an account invitation, use the [Set up to use IBM Cloud](#set-up-to-use-ibm-cloud) section below. + + + + +## Set up to use IBM Cloud + +### Before you begin + +1. If you do not already have one, set up an [IBM Cloud account](https://quantum.cloud.ibm.com/registration). + + You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](https://quantum.cloud.ibm.com) interface. + +1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.) +1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image. + + The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to. + + ![The IBM Quantum Platform header is shown. The account switcher is to the right of the search bar. The region switcher is to the right of the account switcher.](/docs/images/guides/cloud-setup/IQP-Header.avif 'IBM Quantum Platform header') + + +### 1. Create your API key + +In order to authenticate to IBM Quantum Compute Service, you will need an API key. From the [dashboard](https://quantum.cloud.ibm.com/), create your API key then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region. + +### 2. Create an instance + +Access to IBM Quantum Platform services are controlled by the **instances** to which you are assigned. Instances are virtual servers (deployments of IBM Quantum Compute Service) that manage the execution of your workloads, including executing quantum programs and classical compute tasks (such as processing error mitigation). Each instance is identified by their *Cloud Resource Name* (CRN). + +You can create an instance from the IBM Quantum Platform [Instances](https://quantum.cloud.ibm.com/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions. + +To submit workloads from your Qiskit programs to this instance, you will need its CRN. Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. + +### 3. Optional: Save your access credentials + +If you are using a trusted Python environment, such as a personal laptop, it is recommended that you use the `save_account()` method to [save your credentials locally](/docs/guides/save-credentials). + + +### 4. Connect Qiskit with your service instance + +- [Initialize the service](/docs/guides/initialize-account) in a **trusted Python environment** +- [Initialize the service in an **untrusted environment**](/docs/guides/cloud-setup-untrusted) (such as a public computer) + + + * Follow [these instructions](/docs/guides/cloud-setup-rest-api) if you want to connect by using the REST API instead of using Qiskit. + * If necessary, use [this information](/docs/guides/quickstart-steps-org#firewall) to configure your firewall to enable access to the IBM Quantum API endpoints. + + + +## Set up to use IBM Cloud - invited users + +If you do not have an invitation from an administrator to join an account that an administrator set up, contact your administrator. If you need to set up your own account, follow the steps in [Set up your IBM Cloud account](/docs/guides/cloud-setup). + +You can run workloads on IBM® quantum processing units (QPUs) by setting up an account on IBM Cloud®. You will also need to [install and set up Qiskit and the IBM Quantum Compute client](/docs/guides/install-qiskit#local). + + +Your user account is associated with one or more [instances](/docs/guides/instances), identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API token (also called a key) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](/docs/guides/instances#connect-instance). + + + The [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com) and the [Instances page](https://quantum.cloud.ibm.com/instances) list the instances that you can access. + + + + +### Before you begin + +1. Accept the email invitation. +1. Log in with an IBMid or Google account. Note that the profile that you use to log in to IBM Cloud or IBM Quantum Platform in this step is not your IBM Cloud account. After logging in, confirm your information and accept the invitation to join the account. +1. Navigate back to [IBM Quantum Platform](https://quantum.cloud.ibm.com). +1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image. + * Choose the account that was invited in the email. + * The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to. + + ![The IBM Quantum Platform header is shown. The account switcher is to the right of the search bar. The region switcher is to the right of the account switcher.](/docs/images/guides/cloud-setup/IQP-Header.avif 'IBM Quantum Platform header') + +### 1. Create your API key + +In order to authenticate to IBM Quantum Compute Service, you will need an API key. From the [dashboard](https://quantum.cloud.ibm.com/), create your API key then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region. + +### 2. Identify your instance + +To submit workloads from your Qiskit programs, you will also need to identify the instance to submit the worklaod to. Your account administrator has likely already set one up for you. Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. + +### 3. Optional: Save your access credentials + +If you are using a trusted Python environment, such as a personal laptop, it is recommended that you use the `save_account()` method to [save your credentials locally](/docs/guides/save-credentials). + + +### 4. Connect Qiskit with your service instance + +- [Initialize the service](/docs/guides/initialize-account) in a **trusted Python environment** +- [Initialize the service in an **untrusted environment**](/docs/guides/cloud-setup-untrusted) (such as a public computer) + + + * Follow [these instructions](/docs/guides/cloud-setup-rest-api) if you want to connect by using the REST API instead of using Qiskit. + * If necessary, use [this information](/docs/guides/quickstart-steps-org#firewall) to configure your firewall to enable access to the IBM Quantum API endpoints. + + + +## Next steps + + + - [Overview of available plans](plans-overview). + - [Configure the Qiskit SDK locally](configure-qiskit-local). + - [View your available QPUs](/docs/guides/qpu-information#available). + - Follow the steps in the [Run your first circuit on hardware](/docs/guides/hello-world) guide to write and run a quantum program. + - [Set up to use IBM Quantum Platform with REST API](/docs/guides/cloud-setup-rest-api). + - Try a [tutorial](/docs/tutorials). + diff --git a/docs/guides/considerations-set-up-runtime.mdx b/docs/ibm-quantum-platform/considerations-set-up-runtime.mdx similarity index 100% rename from docs/guides/considerations-set-up-runtime.mdx rename to docs/ibm-quantum-platform/considerations-set-up-runtime.mdx diff --git a/docs/guides/custom-roles.mdx b/docs/ibm-quantum-platform/custom-roles.mdx similarity index 100% rename from docs/guides/custom-roles.mdx rename to docs/ibm-quantum-platform/custom-roles.mdx diff --git a/docs/ibm-quantum-platform/index.mdx b/docs/ibm-quantum-platform/index.mdx new file mode 100644 index 00000000000..cd515241e9c --- /dev/null +++ b/docs/ibm-quantum-platform/index.mdx @@ -0,0 +1,13 @@ +--- +title: Introduction to IBM Quantum Platform +description: Introduction to IBM Quantum Platform +--- + + +## IBM Quantum Platform + +IBM Quantum Platform provides a unified environment for managing users and organizations, configuring access plans, viewing and organizing workloads submitted to Quantum Compute, and monitoring system activity. Designed to support teams ranging from individual researchers to enterprise-scale programs, the platform centralizes access to the IBM fleet of quantum processing units (QPUs) and associated services. Administrators can manage memberships and permissions, configure entitlements, and oversee usage, while developers benefit from a consistent interface for interacting with quantum systems. + +To run quantum jobs, users create an [instance](/docs/guides/instances) within the platform. Each instance provides its own Cloud Resource Name (CRN), which is required for submitting workloads to available QPUs. Once configured, users can select or adjust access plans, track job execution, analyze logs, and integrate the platform seamlessly into their development workflows. Together, these capabilities make IBM Quantum Platform the control center for QPU access and quantum application execution. + +For more details, read the [setup documentation](/docs/guides/cloud-setup) for getting started with IBM Quantum Platform. diff --git a/docs/guides/instances.mdx b/docs/ibm-quantum-platform/instances.mdx similarity index 100% rename from docs/guides/instances.mdx rename to docs/ibm-quantum-platform/instances.mdx diff --git a/docs/guides/invite-and-manage-users.mdx b/docs/ibm-quantum-platform/invite-and-manage-users.mdx similarity index 100% rename from docs/guides/invite-and-manage-users.mdx rename to docs/ibm-quantum-platform/invite-and-manage-users.mdx diff --git a/docs/guides/logging.mdx b/docs/ibm-quantum-platform/logging.mdx similarity index 100% rename from docs/guides/logging.mdx rename to docs/ibm-quantum-platform/logging.mdx diff --git a/docs/guides/manage-appid.mdx b/docs/ibm-quantum-platform/manage-appid.mdx similarity index 100% rename from docs/guides/manage-appid.mdx rename to docs/ibm-quantum-platform/manage-appid.mdx diff --git a/docs/guides/manage-cloud-users.mdx b/docs/ibm-quantum-platform/manage-cloud-users.mdx similarity index 100% rename from docs/guides/manage-cloud-users.mdx rename to docs/ibm-quantum-platform/manage-cloud-users.mdx diff --git a/docs/guides/manage-cost.mdx b/docs/ibm-quantum-platform/manage-cost.mdx similarity index 100% rename from docs/guides/manage-cost.mdx rename to docs/ibm-quantum-platform/manage-cost.mdx diff --git a/docs/guides/plans-overview.mdx b/docs/ibm-quantum-platform/plans-overview.mdx similarity index 100% rename from docs/guides/plans-overview.mdx rename to docs/ibm-quantum-platform/plans-overview.mdx diff --git a/docs/guides/quickstart-steps-org.mdx b/docs/ibm-quantum-platform/quickstart-steps-org.mdx similarity index 100% rename from docs/guides/quickstart-steps-org.mdx rename to docs/ibm-quantum-platform/quickstart-steps-org.mdx diff --git a/docs/guides/upgrade-from-open.mdx b/docs/ibm-quantum-platform/upgrade-from-open.mdx similarity index 100% rename from docs/guides/upgrade-from-open.mdx rename to docs/ibm-quantum-platform/upgrade-from-open.mdx diff --git a/docs/guides/DAG-representation.ipynb b/docs/qiskit/DAG-representation.ipynb similarity index 100% rename from docs/guides/DAG-representation.ipynb rename to docs/qiskit/DAG-representation.ipynb diff --git a/docs/qiskit/_toc.json b/docs/qiskit/_toc.json new file mode 100644 index 00000000000..681ccebce76 --- /dev/null +++ b/docs/qiskit/_toc.json @@ -0,0 +1,305 @@ +{ + "parentUrl": "/docs/guides", + "parentLabel": "Documentation", + "title": "Qiskit SDK", + "collapsed": true, + "children": [ + { + "title": "Introduction to Qiskit", + "url": "/docs/qiskit" + }, + { + "title": "Install", + "children": [ + { + "title": "Install Qiskit", + "url": "/docs/qiskit/install-qiskit" + }, + { + "title": "Install the Qiskit SDK from source", + "url": "/docs/qiskit/install-qiskit-source" + }, + { + "title": "Configure the Qiskit SDK locally", + "url": "/docs/qiskit/configure-qiskit-local" + }, + { + "title": "Install the Qiskit C API", + "url": "/docs/qiskit/install-c-api" + }, + { + "title": "Extend Qiskit in Python with C", + "url": "/docs/qiskit/c-extension-for-python" + }, + { + "title": "Online lab environments", + "url": "/docs/qiskit/online-lab-environments" + } + ] + }, + { + "title": "Circuits and operators", + "children": [ + { + "title": "Overview", + "url": "/docs/qiskit/construct-circuits" + }, + { + "title": "Circuit library", + "url": "/docs/qiskit/circuit-library" + }, + { + "title": "Save circuits to disk", + "url": "/docs/qiskit/save-circuits" + }, + { + "title": "Measure qubits", + "url": "/docs/qiskit/measure-qubits" + }, + { + "title": "Operators module", + "children": [ + { + "title": "Overview of operator classes", + "url": "/docs/qiskit/operators-overview" + }, + { + "title": "The Operator class", + "url": "/docs/qiskit/operator-class" + }, + { + "title": "Synthesize unitary operators", + "url": "/docs/qiskit/synthesize-unitary-operators" + }, + { + "title": "Specify observables in the Pauli basis", + "url": "/docs/qiskit/specify-observables-pauli" + } + ] + }, + { + "title": "Advanced circuit building", + "children": [ + { + "title": "Deferred timing resolution using stretch", + "url": "/docs/qiskit/stretch" + }, + { + "title": "Classical feedforward and control flow", + "url": "/docs/qiskit/classical-feedforward-and-control-flow" + }, + { + "title": "Bit-ordering in the Qiskit SDK", + "url": "/docs/qiskit/bit-ordering" + } + ] + }, + { + "title": "OpenQASM", + "children": [ + { + "title": "Intro to OpenQASM", + "url": "/docs/qiskit/introduction-to-qasm" + }, + { + "title": "OpenQASM 2 and the Qiskit SDK", + "url": "/docs/qiskit/interoperate-qiskit-qasm2" + }, + { + "title": "OpenQASM 3 and the Qiskit SDK", + "url": "/docs/qiskit/interoperate-qiskit-qasm3" + }, + { + "title": "OpenQASM 3 feature table", + "url": "/docs/qiskit/qasm-feature-table" + }, + { + "title": "OpenQASM 3.x live specification", + "url": "https://openqasm.com/" + } + ] + } + ] + }, + { + "title": "Transpilation", + "children": [ + { + "title": "Introduction to transpilation", + "url": "/docs/qiskit/transpile" + }, + { + "title": "Transpiler stages", + "url": "/docs/qiskit/transpiler-stages" + }, + { + "title": "Transpile with pass managers", + "url": "/docs/qiskit/transpile-with-pass-managers" + }, + { + "title": "Create a pass manager for dynamical decoupling", + "url": "/docs/qiskit/dynamical-decoupling-pass-manager" + }, + { + "title": "Configure preset pass managers", + "children": [ + { + "title": "Default settings and configuration options", + "url": "/docs/qiskit/defaults-and-configuration-options" + }, + { + "title": "Set optimization level", + "url": "/docs/qiskit/set-optimization" + }, + { + "title": "Commonly used parameters for transpilation", + "url": "/docs/qiskit/common-parameters" + }, + { + "title": "Represent quantum computers for the transpiler", + "url": "/docs/qiskit/represent-quantum-computers" + } + ] + }, + { + "title": "Compare transpiler settings", + "url": "/docs/qiskit/circuit-transpilation-settings" + }, + { + "title": "Advanced transpilation resources", + "children": [ + { + "title": "Write a custom transpiler pass", + "url": "/docs/qiskit/custom-transpiler-pass" + }, + { + "title": "Create and transpile against custom backends", + "url": "/docs/qiskit/custom-backend" + }, + { + "title": "Install and use transpiler plugins", + "url": "/docs/qiskit/transpiler-plugins" + }, + { + "title": "Create a transpiler plugin", + "url": "/docs/qiskit/create-transpiler-plugin" + }, + { + "title": "Work with DAGs in transpiler passes", + "url": "/docs/qiskit/DAG-representation" + }, + { + "title": "AI-powered transpiler passes", + "url": "/docs/qiskit/ai-transpiler-passes" + } + ] + } + ] + }, + { + "title": "Primitives", + "children": [ + { + "title": "Introduction to primitives", + "url": "/docs/qiskit/primitives" + }, + { + "title": "Primitive inputs and outputs", + "url": "/docs/qiskit/primitive-input-output" + }, + { + "title": "Get started with the backend primitives", + "url": "/docs/qiskit/get-started-with-backend-primitives" + }, + { + "title": "Exact simulation with Qiskit SDK primitives", + "url": "/docs/qiskit/simulate-with-qiskit-sdk-primitives" + } + ] + }, + { + "title": "Debugging", + "children": [ + { + "title": "Simulate circuits with noise", + "children": [ + { + "title": "Introduction", + "url": "/docs/qiskit/debugging-tools" + }, + { + "title": "Exact and noisy simulation with Qiskit Aer primitives", + "url": "/docs/qiskit/simulate-with-qiskit-aer" + }, + { + "title": "Exact simulation with Qiskit SDK primitives", + "url": "/docs/qiskit/simulate-with-qiskit-sdk-primitives" + }, + { + "title": "Build noise models", + "url": "/docs/qiskit/build-noise-models" + }, + { + "title": "Efficient simulation of stabilizer circuits with Qiskit Aer primitives", + "url": "/docs/qiskit/simulate-stabilizer-circuits" + } + ] + }, + { + "title": "Visualization", + "children": [ + { + "title": "Visualize circuits", + "url": "/docs/qiskit/visualize-circuits" + }, + { + "title": "Visualize circuit timing", + "url": "/docs/qiskit/visualize-circuit-timing" + }, + { + "title": "Plot quantum states", + "url": "/docs/qiskit/plot-quantum-states" + }, + { + "title": "Visualize results", + "url": "/docs/qiskit/visualize-results" + } + ] + } + ] + }, + { + "title": "Advanced techniques - Qiskit addons", + "url": "/docs/guides/addons" + }, + { + "title": "Integrate external quantum resources with Qiskit", + "url": "/docs/qiskit/create-a-provider" + }, + { + "title": "Integrations", + "children": [ + { + "title": "Quantum resource management interface (QRMI)", + "url": "/docs/qiskit/qrmi" + }, + { + "title": "SPANK plugin for QRMI", + "url": "/docs/qiskit/slurm-plugin" + }, + { + "title": "SPANK plugin user guide", + "url": "/docs/qiskit/slurm-hpc-ux" + }, + { + "title": "Qiskit MCP servers", + "url": "/docs/qiskit/qiskit-mcp-servers" + } + ] + }, + { + "title": "Qiskit Code Assistant", + "url": "/docs/qiskit/qiskit-code-assistant" + } + ] +} diff --git a/docs/guides/ai-transpiler-passes.ipynb b/docs/qiskit/ai-transpiler-passes.ipynb similarity index 100% rename from docs/guides/ai-transpiler-passes.ipynb rename to docs/qiskit/ai-transpiler-passes.ipynb diff --git a/docs/guides/bit-ordering.ipynb b/docs/qiskit/bit-ordering.ipynb similarity index 100% rename from docs/guides/bit-ordering.ipynb rename to docs/qiskit/bit-ordering.ipynb diff --git a/docs/guides/build-noise-models.ipynb b/docs/qiskit/build-noise-models.ipynb similarity index 100% rename from docs/guides/build-noise-models.ipynb rename to docs/qiskit/build-noise-models.ipynb diff --git a/docs/guides/c-extension-for-python.mdx b/docs/qiskit/c-extension-for-python.mdx similarity index 100% rename from docs/guides/c-extension-for-python.mdx rename to docs/qiskit/c-extension-for-python.mdx diff --git a/docs/guides/circuit-library.ipynb b/docs/qiskit/circuit-library.ipynb similarity index 100% rename from docs/guides/circuit-library.ipynb rename to docs/qiskit/circuit-library.ipynb diff --git a/docs/guides/circuit-transpilation-settings.ipynb b/docs/qiskit/circuit-transpilation-settings.ipynb similarity index 100% rename from docs/guides/circuit-transpilation-settings.ipynb rename to docs/qiskit/circuit-transpilation-settings.ipynb diff --git a/docs/guides/classical-feedforward-and-control-flow.ipynb b/docs/qiskit/classical-feedforward-and-control-flow.ipynb similarity index 100% rename from docs/guides/classical-feedforward-and-control-flow.ipynb rename to docs/qiskit/classical-feedforward-and-control-flow.ipynb diff --git a/docs/guides/common-parameters.ipynb b/docs/qiskit/common-parameters.ipynb similarity index 100% rename from docs/guides/common-parameters.ipynb rename to docs/qiskit/common-parameters.ipynb diff --git a/docs/guides/configure-qiskit-local.mdx b/docs/qiskit/configure-qiskit-local.mdx similarity index 100% rename from docs/guides/configure-qiskit-local.mdx rename to docs/qiskit/configure-qiskit-local.mdx diff --git a/docs/guides/construct-circuits.ipynb b/docs/qiskit/construct-circuits.ipynb similarity index 100% rename from docs/guides/construct-circuits.ipynb rename to docs/qiskit/construct-circuits.ipynb diff --git a/docs/guides/create-a-provider.mdx b/docs/qiskit/create-a-provider.mdx similarity index 100% rename from docs/guides/create-a-provider.mdx rename to docs/qiskit/create-a-provider.mdx diff --git a/docs/guides/create-transpiler-plugin.ipynb b/docs/qiskit/create-transpiler-plugin.ipynb similarity index 100% rename from docs/guides/create-transpiler-plugin.ipynb rename to docs/qiskit/create-transpiler-plugin.ipynb diff --git a/docs/guides/custom-backend.ipynb b/docs/qiskit/custom-backend.ipynb similarity index 100% rename from docs/guides/custom-backend.ipynb rename to docs/qiskit/custom-backend.ipynb diff --git a/docs/guides/custom-transpiler-pass.ipynb b/docs/qiskit/custom-transpiler-pass.ipynb similarity index 100% rename from docs/guides/custom-transpiler-pass.ipynb rename to docs/qiskit/custom-transpiler-pass.ipynb diff --git a/docs/guides/debugging-tools.mdx b/docs/qiskit/debugging-tools.mdx similarity index 100% rename from docs/guides/debugging-tools.mdx rename to docs/qiskit/debugging-tools.mdx diff --git a/docs/guides/defaults-and-configuration-options.ipynb b/docs/qiskit/defaults-and-configuration-options.ipynb similarity index 100% rename from docs/guides/defaults-and-configuration-options.ipynb rename to docs/qiskit/defaults-and-configuration-options.ipynb diff --git a/docs/guides/dynamical-decoupling-pass-manager.ipynb b/docs/qiskit/dynamical-decoupling-pass-manager.ipynb similarity index 100% rename from docs/guides/dynamical-decoupling-pass-manager.ipynb rename to docs/qiskit/dynamical-decoupling-pass-manager.ipynb diff --git a/docs/guides/get-started-with-backend-primitives.mdx b/docs/qiskit/get-started-with-backend-primitives.mdx similarity index 100% rename from docs/guides/get-started-with-backend-primitives.mdx rename to docs/qiskit/get-started-with-backend-primitives.mdx diff --git a/docs/guides/tools-intro.mdx b/docs/qiskit/index.mdx similarity index 100% rename from docs/guides/tools-intro.mdx rename to docs/qiskit/index.mdx diff --git a/docs/guides/install-c-api.mdx b/docs/qiskit/install-c-api.mdx similarity index 100% rename from docs/guides/install-c-api.mdx rename to docs/qiskit/install-c-api.mdx diff --git a/docs/guides/install-qiskit-source.mdx b/docs/qiskit/install-qiskit-source.mdx similarity index 100% rename from docs/guides/install-qiskit-source.mdx rename to docs/qiskit/install-qiskit-source.mdx diff --git a/docs/guides/install-qiskit.mdx b/docs/qiskit/install-qiskit.mdx similarity index 100% rename from docs/guides/install-qiskit.mdx rename to docs/qiskit/install-qiskit.mdx diff --git a/docs/guides/interoperate-qiskit-qasm2.ipynb b/docs/qiskit/interoperate-qiskit-qasm2.ipynb similarity index 100% rename from docs/guides/interoperate-qiskit-qasm2.ipynb rename to docs/qiskit/interoperate-qiskit-qasm2.ipynb diff --git a/docs/guides/interoperate-qiskit-qasm3.ipynb b/docs/qiskit/interoperate-qiskit-qasm3.ipynb similarity index 100% rename from docs/guides/interoperate-qiskit-qasm3.ipynb rename to docs/qiskit/interoperate-qiskit-qasm3.ipynb diff --git a/docs/guides/introduction-to-qasm.mdx b/docs/qiskit/introduction-to-qasm.mdx similarity index 100% rename from docs/guides/introduction-to-qasm.mdx rename to docs/qiskit/introduction-to-qasm.mdx diff --git a/docs/guides/measure-qubits.ipynb b/docs/qiskit/measure-qubits.ipynb similarity index 100% rename from docs/guides/measure-qubits.ipynb rename to docs/qiskit/measure-qubits.ipynb diff --git a/docs/guides/online-lab-environments.mdx b/docs/qiskit/online-lab-environments.mdx similarity index 100% rename from docs/guides/online-lab-environments.mdx rename to docs/qiskit/online-lab-environments.mdx diff --git a/docs/guides/operator-class.ipynb b/docs/qiskit/operator-class.ipynb similarity index 100% rename from docs/guides/operator-class.ipynb rename to docs/qiskit/operator-class.ipynb diff --git a/docs/guides/operators-overview.ipynb b/docs/qiskit/operators-overview.ipynb similarity index 100% rename from docs/guides/operators-overview.ipynb rename to docs/qiskit/operators-overview.ipynb diff --git a/docs/guides/plot-quantum-states.ipynb b/docs/qiskit/plot-quantum-states.ipynb similarity index 100% rename from docs/guides/plot-quantum-states.ipynb rename to docs/qiskit/plot-quantum-states.ipynb diff --git a/docs/guides/primitive-input-output.ipynb b/docs/qiskit/primitive-input-output.ipynb similarity index 100% rename from docs/guides/primitive-input-output.ipynb rename to docs/qiskit/primitive-input-output.ipynb diff --git a/docs/guides/primitives.ipynb b/docs/qiskit/primitives.ipynb similarity index 100% rename from docs/guides/primitives.ipynb rename to docs/qiskit/primitives.ipynb diff --git a/docs/guides/qasm-feature-table.mdx b/docs/qiskit/qasm-feature-table.mdx similarity index 100% rename from docs/guides/qasm-feature-table.mdx rename to docs/qiskit/qasm-feature-table.mdx diff --git a/docs/guides/qiskit-code-assistant.mdx b/docs/qiskit/qiskit-code-assistant.mdx similarity index 100% rename from docs/guides/qiskit-code-assistant.mdx rename to docs/qiskit/qiskit-code-assistant.mdx diff --git a/docs/guides/qiskit-mcp-servers.mdx b/docs/qiskit/qiskit-mcp-servers.mdx similarity index 100% rename from docs/guides/qiskit-mcp-servers.mdx rename to docs/qiskit/qiskit-mcp-servers.mdx diff --git a/docs/guides/qrmi.mdx b/docs/qiskit/qrmi.mdx similarity index 100% rename from docs/guides/qrmi.mdx rename to docs/qiskit/qrmi.mdx diff --git a/docs/guides/represent-quantum-computers.ipynb b/docs/qiskit/represent-quantum-computers.ipynb similarity index 100% rename from docs/guides/represent-quantum-computers.ipynb rename to docs/qiskit/represent-quantum-computers.ipynb diff --git a/docs/guides/save-circuits.ipynb b/docs/qiskit/save-circuits.ipynb similarity index 100% rename from docs/guides/save-circuits.ipynb rename to docs/qiskit/save-circuits.ipynb diff --git a/docs/guides/set-optimization.ipynb b/docs/qiskit/set-optimization.ipynb similarity index 100% rename from docs/guides/set-optimization.ipynb rename to docs/qiskit/set-optimization.ipynb diff --git a/docs/guides/simulate-stabilizer-circuits.ipynb b/docs/qiskit/simulate-stabilizer-circuits.ipynb similarity index 100% rename from docs/guides/simulate-stabilizer-circuits.ipynb rename to docs/qiskit/simulate-stabilizer-circuits.ipynb diff --git a/docs/guides/simulate-with-qiskit-aer.ipynb b/docs/qiskit/simulate-with-qiskit-aer.ipynb similarity index 100% rename from docs/guides/simulate-with-qiskit-aer.ipynb rename to docs/qiskit/simulate-with-qiskit-aer.ipynb diff --git a/docs/guides/simulate-with-qiskit-sdk-primitives.ipynb b/docs/qiskit/simulate-with-qiskit-sdk-primitives.ipynb similarity index 100% rename from docs/guides/simulate-with-qiskit-sdk-primitives.ipynb rename to docs/qiskit/simulate-with-qiskit-sdk-primitives.ipynb diff --git a/docs/guides/slurm-hpc-ux.mdx b/docs/qiskit/slurm-hpc-ux.mdx similarity index 100% rename from docs/guides/slurm-hpc-ux.mdx rename to docs/qiskit/slurm-hpc-ux.mdx diff --git a/docs/guides/slurm-plugin.mdx b/docs/qiskit/slurm-plugin.mdx similarity index 100% rename from docs/guides/slurm-plugin.mdx rename to docs/qiskit/slurm-plugin.mdx diff --git a/docs/guides/specify-observables-pauli.ipynb b/docs/qiskit/specify-observables-pauli.ipynb similarity index 100% rename from docs/guides/specify-observables-pauli.ipynb rename to docs/qiskit/specify-observables-pauli.ipynb diff --git a/docs/guides/stretch.mdx b/docs/qiskit/stretch.mdx similarity index 100% rename from docs/guides/stretch.mdx rename to docs/qiskit/stretch.mdx diff --git a/docs/guides/synthesize-unitary-operators.ipynb b/docs/qiskit/synthesize-unitary-operators.ipynb similarity index 100% rename from docs/guides/synthesize-unitary-operators.ipynb rename to docs/qiskit/synthesize-unitary-operators.ipynb diff --git a/docs/guides/transpile-with-pass-managers.ipynb b/docs/qiskit/transpile-with-pass-managers.ipynb similarity index 100% rename from docs/guides/transpile-with-pass-managers.ipynb rename to docs/qiskit/transpile-with-pass-managers.ipynb diff --git a/docs/guides/transpile.mdx b/docs/qiskit/transpile.mdx similarity index 100% rename from docs/guides/transpile.mdx rename to docs/qiskit/transpile.mdx diff --git a/docs/guides/transpiler-plugins.ipynb b/docs/qiskit/transpiler-plugins.ipynb similarity index 100% rename from docs/guides/transpiler-plugins.ipynb rename to docs/qiskit/transpiler-plugins.ipynb diff --git a/docs/guides/transpiler-stages.ipynb b/docs/qiskit/transpiler-stages.ipynb similarity index 100% rename from docs/guides/transpiler-stages.ipynb rename to docs/qiskit/transpiler-stages.ipynb diff --git a/docs/guides/visualize-circuit-timing.ipynb b/docs/qiskit/visualize-circuit-timing.ipynb similarity index 100% rename from docs/guides/visualize-circuit-timing.ipynb rename to docs/qiskit/visualize-circuit-timing.ipynb diff --git a/docs/guides/visualize-circuits.ipynb b/docs/qiskit/visualize-circuits.ipynb similarity index 100% rename from docs/guides/visualize-circuits.ipynb rename to docs/qiskit/visualize-circuits.ipynb diff --git a/docs/guides/visualize-results.ipynb b/docs/qiskit/visualize-results.ipynb similarity index 100% rename from docs/guides/visualize-results.ipynb rename to docs/qiskit/visualize-results.ipynb