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.

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

Add notebook about introduction to qmatchatea backend to docs #89

Merged
merged 3 commits into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
15 changes: 15 additions & 0 deletions doc/source/code-examples/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _examples:

Code examples
=============

In this section we present code examples from basic to advanced features
implemented in Qibotn.

Introduction to backends
^^^^^^^^^^^^^^^^^^^^^^^^

.. toctree::
:maxdepth: 1

tutorials/qmatchatea_intro/qmatchatea_intro.ipynb
Copy link
Member

Choose a reason for hiding this comment

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

Why don't you move directly the notebook here, instead of keeping a symlink?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, just wanted to keep the same structure we have in Qibo ig :)

Copy link
Member

Choose a reason for hiding this comment

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

Well, just wanted to keep the same structure we have in Qibo ig :)

I'd say there is no need. Once it is in the docs, it is definitely enough ^^

(Qibo is also using the structure to run the examples, but you could do the same even keeping them in the docs - the important is them being somewhere)

1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"sphinx.ext.intersphinx",
"sphinx_copybutton",
"sphinxcontrib.katex",
"nbsphinx",
]

templates_path = ["_templates"]
Expand Down
1 change: 1 addition & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Contents
:caption: Introduction

getting-started/index
code-examples/index

.. toctree::
:maxdepth: 1
Expand Down
Binary file removed examples/qmatchatea_intro/qibojit_errs.npy
Binary file not shown.
Binary file removed examples/qmatchatea_intro/qibojit_times.npy
Binary file not shown.
Binary file removed examples/qmatchatea_intro/qmatcha_errs.npy
Binary file not shown.
Binary file removed examples/qmatchatea_intro/qmatcha_times.npy
Binary file not shown.
546 changes: 144 additions & 402 deletions examples/qmatchatea_intro/qmatchatea_introduction.ipynb

Large diffs are not rendered by default.