From 603cf3712da77feda17fd9997b8d9f43d52c0a45 Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Tue, 23 Apr 2024 14:04:23 -0400 Subject: [PATCH 1/5] Add embedded youtube video --- docs/start/install.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/start/install.mdx b/docs/start/install.mdx index f7689e29771..2c134156e73 100644 --- a/docs/start/install.mdx +++ b/docs/start/install.mdx @@ -6,6 +6,8 @@ description: Install the Qiskit SDK and Qiskit Runtime on various operating syst # Install Qiskit + + Whether you will work locally or in a cloud environment, the first step for all users is to install Qiskit. For those wanting to run on a real system, your next step is to choose one of two channels in order to access IBM Quantum™ systems: IBM Quantum Platform or IBM Cloud®. @@ -124,8 +126,6 @@ Whether you will work locally or in a cloud environment, the first step for all jupyter notebook path/to/notebook.ipynb ``` - - If you are planning to work locally and use simulators built into Qiskit, then your installation is done. If you want to run jobs on IBM Quantum systems, next [select an access channel](setup-channel) and finish your setup. ## Troubleshooting From 4ef7bf99eab2556ab3b685a21d7012a6669f83f9 Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Tue, 23 Apr 2024 14:07:15 -0400 Subject: [PATCH 2/5] update and move the versions admonition --- docs/start/install.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/start/install.mdx b/docs/start/install.mdx index 2c134156e73..a2446e81846 100644 --- a/docs/start/install.mdx +++ b/docs/start/install.mdx @@ -94,9 +94,6 @@ Whether you will work locally or in a cloud environment, the first step for all ```shell pip install qiskit-ibm-runtime ``` - - Periodically rerun these commands or check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) so that you always have the latest versions. - If you intend to use visualization functionality or Jupyter notebooks, it is recommended to install Qiskit with the extra visualization support. Note that **zsh users** need to put `'qiskit[visualization]'` in single quotes. @@ -128,6 +125,10 @@ Whether you will work locally or in a cloud environment, the first step for all If you are planning to work locally and use simulators built into Qiskit, then your installation is done. If you want to run jobs on IBM Quantum systems, next [select an access channel](setup-channel) and finish your setup. + + Periodically run ` pip install -I` or check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) so that you always have the latest versions. + + ## Troubleshooting
From 27314c4c0a542567f489b4103074a948f3d56b3e Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Tue, 23 Apr 2024 16:54:15 -0400 Subject: [PATCH 3/5] 100% width --- docs/start/install.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/start/install.mdx b/docs/start/install.mdx index a2446e81846..1e729bb0c56 100644 --- a/docs/start/install.mdx +++ b/docs/start/install.mdx @@ -6,7 +6,7 @@ description: Install the Qiskit SDK and Qiskit Runtime on various operating syst # Install Qiskit - + Whether you will work locally or in a cloud environment, the first step for all users is to install Qiskit. For those wanting to run on a real system, your next step is to choose one of two channels in order to access IBM Quantum™ systems: IBM Quantum Platform or IBM Cloud®. @@ -125,7 +125,7 @@ Whether you will work locally or in a cloud environment, the first step for all If you are planning to work locally and use simulators built into Qiskit, then your installation is done. If you want to run jobs on IBM Quantum systems, next [select an access channel](setup-channel) and finish your setup. - + Periodically run ` pip install -I` or check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) so that you always have the latest versions. From 85ddc98996bb751426585176e833240533517310 Mon Sep 17 00:00:00 2001 From: abbycross Date: Tue, 23 Apr 2024 17:07:27 -0400 Subject: [PATCH 4/5] code review Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --- docs/start/install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/start/install.mdx b/docs/start/install.mdx index 1e729bb0c56..ee0b2e5f62c 100644 --- a/docs/start/install.mdx +++ b/docs/start/install.mdx @@ -126,7 +126,7 @@ Whether you will work locally or in a cloud environment, the first step for all If you are planning to work locally and use simulators built into Qiskit, then your installation is done. If you want to run jobs on IBM Quantum systems, next [select an access channel](setup-channel) and finish your setup. - Periodically run ` pip install -I` or check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) so that you always have the latest versions. + Periodically check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) to see new releases. We recommend frequently updating your requirements for `qiskit` and `qiskit-ibm-runtime`, such as by bumping the versions in `requirements.txt`. ## Troubleshooting From 96536efb80d80154251fb30252fa22b032500cfa Mon Sep 17 00:00:00 2001 From: abbycross Date: Tue, 23 Apr 2024 17:14:40 -0400 Subject: [PATCH 5/5] more precise language --- docs/start/install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/start/install.mdx b/docs/start/install.mdx index ee0b2e5f62c..6e218f94072 100644 --- a/docs/start/install.mdx +++ b/docs/start/install.mdx @@ -126,7 +126,7 @@ Whether you will work locally or in a cloud environment, the first step for all If you are planning to work locally and use simulators built into Qiskit, then your installation is done. If you want to run jobs on IBM Quantum systems, next [select an access channel](setup-channel) and finish your setup. - Periodically check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) to see new releases. We recommend frequently updating your requirements for `qiskit` and `qiskit-ibm-runtime`, such as by bumping the versions in `requirements.txt`. + Periodically check the [Qiskit release notes](../api/qiskit/release-notes) and the [Qiskit Runtime release notes](../api/qiskit-ibm-runtime/release-notes) to see new releases. We recommend frequently updating your requirements for `qiskit` and `qiskit-ibm-runtime` by, for example, changing the versions in `requirements.txt` to the latest versions. ## Troubleshooting