Made changes to improve plotting data in Qiskit tutorial

Guillermo-Mijares-Vilarino commented 2 years ago

Summary

Made some changes to the Qiskit Visualizations tutorial to make it follow more closely our documentation checklist and guidelines.

Details and comments

Moved imports to where they are strictly needed so the users can better understand what imports are needed for each step.
Changed mixed states explanations to make clear that the coefficients $p_k$ that appear there are probabilities.
Rewrote the plot_state_paulivec explanation to make it clear and remove a formula whose parameters were not explained at all.
Added mention that each spatial component of the Bloch vector is the expected value of that component.
Added a brief conclusion about what the user has achieved with this tutorial.
Transformed the 'plot_histogram()` options explanation into a list for it to be consistent with how other plotting methods are explained.
Added introduction and setup requisites (seaborn needed).
Run the notebook.

Fixes Qiskit/qiskit-tutorials#1436

review-notebook-app[bot] commented 2 years ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

CLAassistant commented 2 years ago

All committers have signed the CLA.

review-notebook-app[bot] commented 2 years ago

View / edit / reply to this conversation on ReviewNB

HuangJunye commented on 2022-07-07T08:00:09Z ----------------------------------------------------------------

Thanks for noticing this. Do you know which part of this "tutorial" requires seaborn? I wonder if it's strictly needed. If not perhaps we can modify that part to remove the dependency on seaborn

Guillermo-Mijares-Vilarino commented on 2022-07-07T09:48:01Z ----------------------------------------------------------------

It's needed for the plot_state_qsphere function. If seaborn is not installed you get the following error:

MissingOptionalLibraryError: "The 'seaborn' library is required to use 'plot_state_qsphere'. You can install it with 'pip install seaborn'."

review-notebook-app[bot] commented 2 years ago

View / edit / reply to this conversation on ReviewNB

HuangJunye commented on 2022-07-07T08:00:11Z ----------------------------------------------------------------

As mentioned in https://github.com/Qiskit/qiskit-tutorials/pull/1342#discussion_r915570617, any mention of qasm_simulator , unitary_simulator and statevector_simulator may need to be changed. I don't what is the standard way to do that. I think it's all AerSimulator with different modes now. We should ask around.

review-notebook-app[bot] commented 2 years ago

View / edit / reply to this conversation on ReviewNB

HuangJunye commented on 2022-07-07T08:00:12Z ----------------------------------------------------------------

Should we use BasicAer or Aer here? I am not sure.

Guillermo-Mijares-Vilarino commented on 2022-07-07T09:57:50Z ----------------------------------------------------------------

Not sure if it actually matters here. From what I know the main difference is that BasicAer runs in Python and Aer runs in C++. Guessing by the name Aer is better overall but here it wouldn't make much of a difference. However, if the most up to date way of simulating is with AerSimulator then we should change to Aer.

review-notebook-app[bot] commented 2 years ago

View / edit / reply to this conversation on ReviewNB

HuangJunye commented on 2022-07-07T08:00:12Z ----------------------------------------------------------------

Making arguments into a list is much cleaner. Thank you!

SooluThomas commented on 2022-07-15T18:22:44Z ----------------------------------------------------------------

Wouldn't it be best to point to the API reference for this?

Guillermo-Mijares-Vilarino commented on 2022-07-18T09:26:47Z ----------------------------------------------------------------

This is actually the problem with most of this tutorial. That's why we decided to erase it and move the contents to API reference if they are not already there.

Guillermo-Mijares-Vilarino commented 2 years ago

It's needed for the plot_state_qsphere function. If seaborn is not installed you get the following error:

MissingOptionalLibraryError: "The 'seaborn' library is required to use 'plot_state_qsphere'. You can install it with 'pip install seaborn'."

View entire conversation on ReviewNB

Guillermo-Mijares-Vilarino commented 2 years ago

Not sure if it actually matters here. From what I know the main difference is that BasicAer runs in Python and Aer runs in C++. Guessing by the name Aer is better overall but here it wouldn't make much of a difference. However, if the most up to date way of simulating is with AerSimulator then we should change to Aer.

View entire conversation on ReviewNB

SooluThomas commented 2 years ago

Wouldn't it be best to point to the API reference for this?

View entire conversation on ReviewNB

Guillermo-Mijares-Vilarino commented 2 years ago

This is actually the problem with most of this tutorial. That's why we decided to erase it and move the contents to API reference if they are not already there.

View entire conversation on ReviewNB

HuangJunye commented 1 year ago

This is superseded by a series of PRs for adding code examples in plotting functions as tracked by this comment https://github.com/Qiskit/qiskit-tutorials/issues/1436#issuecomment-1477837106

Qiskit / qiskit-tutorials

Made changes to improve plotting data in Qiskit tutorial #1345