From c803aa5fd7aaae91f767754a8161ddb6594644ac Mon Sep 17 00:00:00 2001 From: Kaelyn Ferris <43348706+kaelynj@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:44:12 -0600 Subject: [PATCH] Add new FAQ about metapackage and install snippets --- docs/faq.mdx | 8 ++++++++ docs/guides/index.mdx | 25 +++++++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/docs/faq.mdx b/docs/faq.mdx index 3a6101441ef..b73cb0b1f3b 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -38,6 +38,14 @@ Example of citing IBM Quantum Composer: > IBM Quantum Composer. 2023. url: https://quantum.ibm.com/composer +## What happened to Qiskit Aer, Qiskit Nature, Qiskit Experiments, etc.? + +Before the release of the Qiskit SDK v1.0, Qiskit was comprised of many different Python distributions such as: `qiskit-terra`, the compiler core; `qiskit-aer`, the high-performance simulator; the original IBM Quantum™ provider; and several now-obsolete packages providing particular exploratory algorithmic or experiment-running features. + +These separate software packages were combined together into what was called the Qiskit *metapackage* which allowed users to install all of these components together through `pip install qiskit`. This metapackage architecture was removed with the release of the Qiskit SDK v1.0 and each of the individual software distributions need to be installed separately. + +Check out the [Qiskit ecosystem](https://www.ibm.com/quantum/ecosystem) to find the package you may be looking for. You can also read the [1.0 migration guide](./migration-guides/qiskit-1.0-installation#why-these-changes-happened) for more information about why this change happened. + ## Why do I receive the error message "AttributeError: `QuantumCircuit` object has no attribute `save_state`" when using `save_*`method on a circuit? The `save_*` instructions are part of Qiskit Aer project, diff --git a/docs/guides/index.mdx b/docs/guides/index.mdx index 7c4e146ac54..f7e6a081778 100644 --- a/docs/guides/index.mdx +++ b/docs/guides/index.mdx @@ -29,6 +29,14 @@ Some of the most useful features of the Qiskit SDK include: - **Primitives** ([`qiskit.primitives`](/api/qiskit/primitives)) - The module that contains the base definitions and reference implementations of the Sampler and Estimator primitives, from which different quantum hardware providers can derive their own implementations. See more information about the Qiskit Runtime primitives [in the documentation](./primitives). +### Installation + +For a more detailed introduction to installing the Qiskit SDK, check out the [installation page](./install-qiskit). If you're ready to install it now, simply run: + +```bash +pip install qiskit +``` + ### Benchmarking and the Benchpress package Benchmarking is important for comparing the relative performance of quantum software across different stages of a development workflow. Benchmarking tests for quantum software might, for example, look at the speed and quality of building, manipulating, and transpiling circuits. IBM Quantum is committed to delivering the most performant SDK possible, and to that end, the Qiskit SDK is benchmarked using over 1,000 tests developed by leading universities, national labs, and researchers at IBM. The benchmarking suite used for these tests, named Benchpress, is now available as [an open-source package](https://github.com/qiskit/benchpress). You can now use the Benchpress package to perform your own analysis of quantum SDK performance. @@ -44,6 +52,13 @@ Qiskit Runtime is designed to use additional classical and quantum compute resou Qiskit Runtime also includes three types of execution modes for running your quantum program on IBM hardware: _Job_, _Session_, and _Batch_, each of which have different use cases and implications for the quantum job queue. A Job is a single query to a primitive that can be run over a specified number of shots. [Sessions](./sessions) allow you to efficiently run multiple jobs in iterative workloads on quantum computers. [Batch mode](./run-jobs-batch) allows you to submit all your jobs at once for parallel processing. +To quickly install Qiskit Runtime, run the following command +```bash +pip install qiskit-ibm-runtime +``` + +More details on setting up a development environment for building quantum programs can be found in the [installation page](./install-qiskit). + ### Is Qiskit Runtime open-source? The short answer is, _not all of it_. The Qiskit Runtime service 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 Qiskit Runtime client (the interface for users to access the Qiskit Runtime 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 the 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/). @@ -55,6 +70,11 @@ Creating utility-scale quantum applications generally requires a variety of comp - Persist long-running workloads in the cloud, even if your laptop is turned off - Deploy reusable programs in the cloud +If you'd like to start using Qiskit Serverless right, install it with pip: +```bash +pip install qiskit_serverless +``` + ## Qiskit Functions @@ -65,6 +85,11 @@ Qiskit Functions (`qiskit-ibm-catalog.QiskitFunctionsCatalog`) are abstracted se Premium Plan members can access IBM-provided functions right away, or purchase licenses for the partner-provided functions directly from those partners. +The catalog can be installed via pip: +```bash +pip install qiskit-ibm-catalog +``` + ## Qiskit Transpiler as a Service The Qiskit Transpiler Service ([package name `qiskit-ibm-transpiler`](https://pypi.org/project/qiskit-ibm-transpiler/)) is a new experimental service that provides remote transpilation capabilities on the cloud to IBM Quantum Premium Plan users. In addition to the local Qiskit SDK transpiler capabilities, your transpilation tasks can benefit from both IBM Quantum cloud resources and AI-powered transpiler passes using this service. To learn more about how to integrate cloud-based transpilation into your Qiskit workflow you can [check out the documentation](./qiskit-transpiler-service).