qiskit-tutorials icon indicating copy to clipboard operation
qiskit-tutorials copied to clipboard

Made changes to improve getting started tutorial

Open Guillermo-Mijares-Vilarino opened this issue 3 years ago • 4 comments

Summary

Made some changes to the Getting Started with Qiskit 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.
  • Added a link to an explanation of what Greenberger-Horne-Zeilinger (GHZ) states are. In the tutorial they are mentioned as if they were known by users but it may not be the case.
  • Changed the titles of some steps so they are actions instead of nouns.
  • Explained that when using QuantumCircuit.draw('mpl') we are using Matplotlib and showed the difference between using and not using Matplotlib. Originally the 'mpl' option appeared without any acknowledgement.
  • Mentioned the possibility of reversing the order of the qubits when drawing a circuit so the most significant qubits are at the top and showed it with a quick example. Even if it goes slightly against the checklist (better to not provide options) I believe it can make a big difference for people who have more Physics-oriented backgrounds (like me) and are used to drawing circuits that way. I really appreciated that option when I got started with Qiskit.
  • Expanded a bit the explanation on building the circuit with the measures. In particular, I explained what the barrier does
  • Corrected a typo in which it is said that get_counts(circuit) is a function instead of a method.
  • Put some attention to the fact that we are transpiling the circuit before running it.
  • Added a brief conclusion about what the user has achieved with this tutorial.
  • Changed the first sentence so it's more focused on the user. Our guidelines state that it's preferable to involve the user by saying "you are going to do x" instead of "we are showing you x"
  • Removed references to statevector_simulator, qasm_simulator and unitary_simulator and focused on only one example of AerSimulator.
  • Added links to API references for gates, simulators and visualization options.
  • Removed references to deprecated execute function and changed them to references to run method.
  • Added a "Visualize the results" section.

Fixes Qiskit/qiskit#1520

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Jul 05 '22 13:07 CLAassistant

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Jul 05 '22 13:07 CLAassistant

@Guillermo-Mijares-Vilarino I left some comments. I haven't read through the whole tutorial yet. I will finish the review next week.

HuangJunye avatar Jul 14 '22 10:07 HuangJunye

This is staled. Closing it.

HuangJunye avatar May 09 '23 11:05 HuangJunye