Skip to content

[WIP] surface code demo#1797

Open
Qottmann wants to merge 29 commits into
masterfrom
surfacecode
Open

[WIP] surface code demo#1797
Qottmann wants to merge 29 commits into
masterfrom
surfacecode

Conversation

@Qottmann

Copy link
Copy Markdown
Collaborator

Title:

Surface code demo

Summary:

Addin a demo on the basics of the surface code

Relevant references:

Possible Drawbacks:

Related GitHub Issues:


If you are writing a demonstration, please answer these questions to facilitate the marketing process.

  • GOALS — Why are we working on this now?

    Eg. Promote a new PL feature or show a PL implementation of a recent paper.

  • AUDIENCE — Who is this for?

    Eg. Chemistry researchers, PL educators, beginners in quantum computing.

  • KEYWORDS — What words should be included in the marketing post?

  • Which of the following types of documentation is most similar to your file?
    (more details here)

  • Tutorial
  • Demo
  • How-to

@Qottmann Qottmann requested review from a team as code owners May 26, 2026 15:36
@github-actions

Copy link
Copy Markdown

👋 Hey, looks like you've updated some demos!

🐘 Don't forget to update the dateOfLastModification in the associated metadata files so your changes are reflected in Glass Onion (search and recommendations).

Please hide this comment once the field(s) are updated. Thanks!

@github-actions

github-actions Bot commented May 26, 2026

Copy link
Copy Markdown

Your preview is ready 🎉!

You can view your changes here

Deployed at: 2026-06-29 13:58:53 UTC

Comment thread demonstrations_v2/tutorial_surface_code/demo.py Outdated
@Qottmann

Copy link
Copy Markdown
Collaborator Author

drawings are done here (in case someone needs to edit something in the future)

https://docs.google.com/presentation/d/1qT5T15coMmlAafnHxLR1EzwljRnlQg06x4TIhElosp8/edit?usp=sharing

Comment thread demonstrations_v2/tutorial_surface_code/metadata.json Outdated
Comment thread demonstrations_v2/tutorial_surface_code/metadata.json Outdated
Qottmann and others added 2 commits June 24, 2026 11:52
Co-authored-by: drdren <104710745+drdren@users.noreply.github.com>
Co-authored-by: drdren <104710745+drdren@users.noreply.github.com>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi @Qottmann ! I will do a more thorough content review later, but could for SEO discoverability and LLM accommodation, could you please change the folder name to "surface-code"? I'm afraid that affects all the other intersphinx links too: <demos/surface-code>

The reason is two-fold. Firstly, search engines and LLMs (in particular) parse anything with an underscore as one word. So, this URL will be tokenised as tutorialsurfacecode, and not match anything internal search of surface code. The second reason is that tutorial is the first thing that the search engine "sees" and we want "surface code" to be the first thing that the search engine "sees."

Of course, these are minor tweaks in the grand schemes of things because the title has Surface Code in it. Still, I hope these are low-effort changes on our end that increase the number of people reading your demo!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I can make those changes myself if you prefer.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

sure feel free to update them!

Comment thread demonstrations_v2/tutorial_surface_code/demo.py Outdated
Qottmann and others added 2 commits June 29, 2026 14:05
Co-authored-by: drdren <104710745+drdren@users.noreply.github.com>
Comment thread demonstrations_v2/tutorial_active_volume/demo.py Outdated
Comment thread demonstrations_v2/tutorial_bp_catalyst/demo.py Outdated
Comment thread demonstrations_v2/tutorial_fault_tolerant_threshold/demo.py Outdated
Comment thread demonstrations_v2/tutorial_game_of_surface_codes/demo.py Outdated
Comment thread demonstrations_v2/tutorial_lattice_surgery/demo.py Outdated
Comment thread demonstrations_v2/tutorial_magic_states/demo.py Outdated
Comment thread demonstrations_v2/tutorial_mbqc/demo.py Outdated
Comment thread demonstrations_v2/tutorial_qldpc_codes/demo.py Outdated
Comment thread demonstrations_v2/tutorial_stabilizer_codes/demo.py Outdated
Comment thread demonstrations_v2/tutorial_toric_code/demo.py Outdated
drdren added 2 commits June 29, 2026 09:51
Co-authored-by: drdren <104710745+drdren@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants