qiskit / textbook Goto Github PK

Once up and running, we should adapt this repo so it can join the Qiskit Ecosystem

https://github.com/Qiskit/saiba/issues/new/choose (as by issue templates last option results in a 404)

New contributors

The textbook is a good starting point for first time GitHub contributors. We should make sure the contributing docs are clear & accurate.

• Test on OSX users
• Test on Windows users

Textbook-specific docs

We should document things that are non-standard, or might not be obvious to experienced users working on the textbook.

• Add info on custom syntax for widgets

Is your suggestion related to a problem? Please describe.
In section 1.3 of Berstein-Vazirani there is an inconsistency when explaining the input to the oracle $f_s$, as in the second to last equation it shows as if we want to obtain $a$, even though this was referred to as the initial state, and the string we want to find out is rather $s$.

This in my opinion makes it a big hard to follow. In the examples that follow, again the string is referred as $s$ and not $a$.

Describe the solution you'd like
In the last two equations of section 1.3, the $a$'s should be changed for $s$'s.

Describe alternatives you've considered
NA

Where is the problem?
https://learn.qiskit.org/course/ch-applications/solving-linear-systems-of-equations-using-hhl-and-its-qiskit-implementation

Describe the problem
On the solving linear systems of equations using HHL algorithm and its Qiskit implementation page in section 2.2/2.B the second and fifth points are not legible due to incorrect Tex formatting.

Expected behavior
Proper math format.

Screenshots

Is your suggestion related to a problem? Please describe.
In Unit 1, Lesson 4 "Entanglement in Action", 5th paragraph of "Superdense coding," there is mention of the "complementary relationship with teleportation," and claims that further discussion will occur "at the end of the section". There is no further discussion on the topic.

Describe the solution you'd like
To delete paragraph 5 of "Superdense coding" in Lesson 4, Entanglement in action. That is, delete the text "Another reason why superdense coding... at the end of the section."

Describe alternatives you've considered
Later, the alluded to discussion may be added back in, but the above fix will do for now.

Additional context
Add any other context or screenshots about the feature request here.

Page: https://learn.qiskit.org/summer-school/2022/introduction-linear-algebra-prerequisite-mathematics-circuit-composition#introduction-0-12)

On that page towards the bottom, the "Suggested reading Learn Quantum Computation Using Qiskit: 8.1 Linear Algebra" link is broken.

Where is the problem?
[Please paste a link to the page.]
(https://learn.qiskit.org/course/ch-applications/solving-combinatorial-optimization-problems-using-qaoa)

Describe the problem
A clear and concise description of what is wrong and why.
There's a Tex-error on this page:
$x_3 = 0$
(search for '$')

Expected behavior
(Optional) Explain what you expect to see instead.
There are TeX-errors on many pages of the tutorial, I'll start reporting them as I go through the tutorial. This one is simple, but there are other sophisticated TeX-errors.

Screenshots
(Optional) If applicable, add screenshots to help explain your problem.

Additional context / references
If needed, I could directly correct those TeX-errors. However, I don't have the necessary rights.

To close this issue, we need to remove the textbook notebooks from the notebook folder in Qiskit/platypus and include this repo as a submodule in that folder. Will also need to modify the platypus converter to handle this.

EDIT: For content contributors, we also need an easy way of previewing pages locally.

Where is the problem?
The issue is in "Quantum States" chapter in the "Atoms of Computation Section" under the "Adding with Qiskit" section.
Here is the link:

https://learn.qiskit.org/course/ch-states/the-atoms-of-computation#adding-qiskit

Relatedly, this can also be seen in input line 15 of the notebook:

https://github.com/Qiskit/textbook/blob/main/notebooks/ch-states/atoms-computation.ipynb

Describe the problem
When trying to run this cell, which includes the command "Assemble", the cell fails and the output returns the following error message:

Traceback (most recent call last):
  Cell In[59], line 2
    counts = sim.run(qobj).result().get_counts()
  File /opt/conda/lib/python3.10/site-packages/qiskit_aer/backends/aerbackend.py:196 in run
    return self._run_qobj(circuits, validate, parameter_binds, **run_options)
TypeError: AerBackend._run_qobj() got multiple values for argument 'parameter_binds'

Use %tb to get the full traceback.
/tmp/ipykernel_103/2201439370.py:2: DeprecationWarning: Using a qobj for run() is deprecated as of qiskit-aer 0.9.0 and will be removed no sooner than 3 months from that release date. Transpiled circuits should now be passed directly using `backend.run(circuits, **run_options).
  counts = sim.run(qobj).result().get_counts()

NOTE: this output is already different from the notebook linked above. In the above notebook link, the output is still displayed. However, when I ran it today on an IBM cloud notebook, there was no output and only the error message.

Expected behavior

This code should return a histogram plot instead of error.

Additional context / references

In order to get the expected behaviour, I followed the advice described in the DeprecationWarning and replaced the code in the original cell, ie

qobj = assemble(qc_ha)
counts = sim.run(qobj).result().get_counts()
plot_histogram(counts)

with

counts = sim.run(qc_ha).result().get_counts()
plot_histogram(counts)

https://learn.qiskit.org/course/v2_ch-states/atoms-computation

This should be Aer.get_backend.

We should make it clear how to cite the textbook. We did have a bibtex file a while ago, but I think a link to this repo is more appropriate now.

We include some scripts to automatically set up the Python environment (see readme), but I've only tested it on OSX. To close this issue, we need confirmation that users can run the install script to set up their environment on:

• Linux
  • Tested on Fedora
  • Works with Ubuntu (via GitHub action)
• Windows

and include any OS-specific instructions .

Describe the bug
When executing the command "install.sh" I get the error:
ERROR: The tar file (C:\Users\A400919\AppData\Local\Temp\pip-unpack-8e74pa24\pyscf-2.0.1.tar.gz) has a file (C:\Users\A400919\AppData\Local\Temp\pip-install-1y5k_ggc\pyscf_a7e51574f1e84b7e821cb21216ad8b29\pyscf/agf2/aux.py) trying to install outside target directory (C:\Users\A400919\AppData\Local\Temp\pip-install-1y5k_ggc\pyscf_a7e51574f1e84b7e821cb21216ad8b29)

To Reproduce
Steps to reproduce the behavior:

1. Go to Github/textbook
2. Run script 'install.sh
3. See error above

Expected behavior
The script doesn't terminate with success, throws an error instead

Desktop (please complete the following information):

• OS: [e.g. iOS] Windows
• Program versions: Python 3.9.1

Additional context
According to my first assessment this is due to the file aux.py which is an invalid filename on Windows

Describe the problem?
In last cell of Shor's algorithm lab at https://learn.qiskit.org/course/ch-algorithms/shors-algorithm; running the last cell does not print out the expected guess value. It prints *** Non-trivial factor found: {guess} ***

Expected behavior
It would be nice to see the actual guess value as shown in the sample output in the lab

Proposed fix
Use python string formatting (ie print(f"*** Non-trivial factor found: {guess} ***")

To close this issue, we need to remove the content folder from qiskit-community/qiskit-textbook and replace it with this repo as a submodule.

Where is the problem?
Classical Computing on a Quantum Computer - Qiskit Textbook
very near the bottom of the page.
Describe the problem
The output from the last interactive box produces an image different than the original image. In other words, running (Vf.inverse().compose(copy).compose(Vf)).draw() changes the circuit shown immediately below it. Instead it shows a circuit with only three qubits.

Expected behavior
The code should display a circuit with four qubits.

Screenshots

This is what you should see (and do immediately after reloading the page):

This is the result you get from running all the code on the page:

Where is the problem?
https://learn.qiskit.org/course/introduction/the-atoms-of-computation

Describe the problem
In the "Your first quantum circuit" section the package that is used to import the AerSimulator is incorrect.
Expected behavior
Instead of importing the AerSimulator from qiskit.providers.aer it should be imported from qiskit_aer. At least this is what works locally.