Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install page updates #1223

Merged
merged 5 commits into from
Apr 24, 2024
Merged

Install page updates #1223

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
603cf37
Add embedded youtube video
abbycross Apr 23, 2024
4ef7bf9
update and move the versions admonition
abbycross Apr 23, 2024
27314c4
100% width
abbycross Apr 23, 2024
85ddc98
code review
abbycross Apr 23, 2024
96536ef
more precise language
abbycross Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/start/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: Install the Qiskit SDK and Qiskit Runtime on various operating syst
<span id="qiskit-install"></span>
# Install Qiskit

<iframe width="100%" height="450" src="https://www.youtube.com/embed/dZWz4Gs_BuI?si=EbbKEtvPAk7G8DRZ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

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&trade; systems: IBM Quantum Platform or IBM Cloud&reg;.

<Admonition type="caution" title="Upgrade from Qiskit 0.x to Qiskit 1.0 and beyond">
Expand Down Expand Up @@ -92,9 +94,6 @@ Whether you will work locally or in a cloud environment, the first step for all
```shell
pip install qiskit-ibm-runtime
```
<Admonition type="note">
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.
</Admonition>

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.

Expand Down Expand Up @@ -124,10 +123,12 @@ 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.

<Admonition type="note" title="Stay current with 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`.
abbycross marked this conversation as resolved.
Show resolved Hide resolved
</Admonition>

## Troubleshooting

<details>
Expand Down
Loading