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

Advanced tutorial on quantum simulation #33

Merged
merged 14 commits into from
Oct 3, 2022
Merged

Advanced tutorial on quantum simulation #33

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
64ed376
added tight binding tutorial
ajrazander Sep 9, 2022
5b5a021
corrected typos
ajrazander Sep 12, 2022
b3889a3
Included Qiskit nature definition of Hamiltonian
ajrazander Sep 13, 2022
3bd597a
Last typo
ajrazander Sep 13, 2022
8183944
Add TODO for Parameter support of FermionicOp
ajrazander Sep 13, 2022
eaa1747
added mthree, rzx compatiblity, typos, prints
ajrazander Sep 22, 2022
86f7ae6
black formatting
ajrazander Sep 22, 2022
5385ec3
only simulated data in plots and simulated backends
ajrazander Sep 25, 2022
be53005
formatting
ajrazander Sep 25, 2022
a06d392
index syntax updates
ajrazander Sep 27, 2022
f751a2d
increased timeout period
ajrazander Sep 28, 2022
a092126
fixed doc section labels
ajrazander Sep 29, 2022
7e090d9
Revert "fixed doc section labels"
ajrazander Oct 3, 2022
029766b
undo edits to protein folding notebook
ajrazander Oct 3, 2022
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
Binary file added docs/tutorial_quantum_sim/figures/lattice.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/tutorial_quantum_sim/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=============================
Tutorial on quantum simulation
=============================

This experiment simulates the time evolution under a tight binding model on IBM Quantum hardware.
The results are published at `arXiv:2209.02795`_.
The documentation for this module consists of one notebook:

1. The `qsim-tight-binding-model`_ contains background information, shows how the building blocks
of the experiment were implemented, collects experimental data, analyzes data, and generates plots.

.. _arXiv:2209.02795: https://arxiv.org/abs/2209.02795
.. _tutorial: qsim-tight-binding-model.ipynb
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the link is written incorrectly. Please build the docs locally and make sure they look correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the index.rst files, and the building is doing better than before, but now it's timing out. I get this output:

.
.
.
Notebook error:
CellTimeoutError in tutorial_quantum_sim/qsim-tight-binding-model.ipynb:
A cell timed out while it was being executed, after 180 seconds.
The message was: Cell execution timed out.
Here is a preview of the cell contents:
-------------------
['# Evaulate all circuits over all time points and take the mean', '', '# Compute parameterized circuit over a range of trotter steps', 'trotter_steps_array = np.arange(1, 13)', '']
...
['    # Calculate average fidelity for a given trotter step', '    qc_rzx_fid_ests.append(np.mean(rzx_fids))', '', '    # Calculate average duration for a given trotter step', '    qc_rzx_dur_ests.append(np.mean(qc_dur))']
-------------------

Task was destroyed but it is pending!
task: <Task pending name='Task-453' coro=<NotebookClient._async_poll_output_msg() running at /Users/ajrasmusson/Documents/GitHub/qiskit-research/.tox/docs/lib/python3.8/site-packages/nbclient/client.py:812> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x7fe8b209b730>()]>>
ERROR: InvocationError for command /Users/ajrasmusson/Documents/GitHub/qiskit-research/.tox/docs/bin/sphinx-build -b html -W docs/ docs/_build/html (exited with code 2)
______________________________________________________ summary ______________________________________________________
ERROR:   docs: commands failed

I'm not sure what the error here is exactly. It seems like the tox -edocs is trying to run the notebook, but one of the cells is taking longer then 180 seconds?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please push your changes and I will investigate increasing the time limit. I'm wondering though, could you take a look at the long-running cell and think about whether there is a reasonable way to make it execute faster?



.. toctree::
:maxdepth: 1

qsim-tight-binding-model

.. Hiding - Indices and tables
:ref:`genindex`
:ref:`modindex`
:ref:`search`

Loading