Add new FAQ about metapackage and include install snippets to intro #2516
Conversation
|
One or more of the following people are relevant to this code: |
Co-authored-by: abbycross <across@us.ibm.com>
docs/guides/index.mdx
Outdated
| @@ -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: | |||
There was a problem hiding this comment.
@abbycross I tihnk this is wrong. More generally, I'm not sure if the install snippets throughout the file follow the right style?
There was a problem hiding this comment.
Here is what the serverless page has - so we should add the qiskit-ibm-catalog part; is that what you mean, @Eric-Arellano? Also, can you clarify what you mean about the install snippets not following the right style?
```bash
pip install qiskit-ibm-catalog qiskit_serverless
Co-authored-by: abbycross <across@us.ibm.com>
docs/guides/index.mdx
Outdated
| @@ -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: | |||
There was a problem hiding this comment.
Here is what the serverless page has - so we should add the qiskit-ibm-catalog part; is that what you mean, @Eric-Arellano? Also, can you clarify what you mean about the install snippets not following the right style?
```bash
pip install qiskit-ibm-catalog qiskit_serverless
docs/guides/index.mdx
Outdated
| @@ -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: | |||
There was a problem hiding this comment.
| If you'd like to start using Qiskit Serverless right, install it with pip: | |
| To start using Qiskit Serverless right away, install it with pip: |
There was a problem hiding this comment.
Is this what you meant @Eric-Arellano?
There was a problem hiding this comment.
Yes, Abby, that is what I meant. I'm also not sure we need to say "right away"?
I also meant to say that we should probably use consistent wording with the prefix sentence for all the install snippets, such as The catalog can be installed via pip:
P.S. aren't we supposed to avoid the word "via"?
There was a problem hiding this comment.
Here's what IBM Style says:
Use this term, which means by way of, to refer to routing data, such as in “Messages are routed via SMTP”. In
other situations, try to replace via with one of the following synonyms: across, along, by, from, on, or through.
"Routing data" seems very specific - do we consider installing a package as data being "routed" to your machine?
There was a problem hiding this comment.
Sort of? I think Becky normally uses "with pip"? That should translate better.
| @@ -38,6 +38,14 @@ Example of citing IBM Quantum Composer: | |||
|
|
|||
| > IBM Quantum Composer. 2023. url: https://<span>quantum.ibm.com/composer</span> | |||
| ## What happened to Python distributions such as Qiskit Aer, Qiskit Nature, and Qiskit Experiments? | |||
There was a problem hiding this comment.
I think we should be more explicit here and warn people that since March 2024 (or whatever date we released the metapackage change) the command pip install qiskit will only install the Qiskit SDK (and link to the github repo), not the other packages.
There was a problem hiding this comment.
I added another couple sentences at the beginning of this section. Let me know if it seems sufficient!
| ```bash | ||
| pip install qiskit-ibm-catalog | ||
| ``` | ||
|
|
||
| ## Qiskit Transpiler as a Service |
There was a problem hiding this comment.
shouldn't we also include some pip install commands for the transpiler service and addons?
There was a problem hiding this comment.
Just added install commands for them
Closes #2486 and closes #2488