Skip to content

Add surface code to pre-built QEC code docs#495

Open
vedika-saravanan wants to merge 2 commits intoNVIDIA:mainfrom
vedika-saravanan:PR-CUDRR1FA267
Open

Add surface code to pre-built QEC code docs#495
vedika-saravanan wants to merge 2 commits intoNVIDIA:mainfrom
vedika-saravanan:PR-CUDRR1FA267

Conversation

@vedika-saravanan
Copy link
Copy Markdown
Collaborator

@vedika-saravanan vedika-saravanan commented Apr 8, 2026

This PR addresses the corresponding GHI: #436

Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
@vedika-saravanan vedika-saravanan changed the title add doc for surface code and sldiing window decoder Add surface code to pre-built QEC code docs Apr 8, 2026
@vedika-saravanan vedika-saravanan marked this pull request as ready for review April 8, 2026 19:48
@vedika-saravanan vedika-saravanan added the documentation Improvements or additions to documentation label Apr 8, 2026
Copy link
Copy Markdown
Collaborator

@justinlietz justinlietz left a comment

Choose a reason for hiding this comment

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

Thanks Vedika, looks great! Perhaps the larger issue is that the surface code utility functions are currently C++ only right now: https://nvidia.github.io/cudaqx/api/qec/cpp_api.html#_CPPv4N5cudaq3qec12surface_code15stabilizer_gridE. We could consider linking to those docs, or adding python bindings for the stabilizer grid tool.

@vedika-saravanan
Copy link
Copy Markdown
Collaborator Author

vedika-saravanan commented Apr 8, 2026

Thanks Vedika, looks great! Perhaps the larger issue is that the surface code utility functions are currently C++ only right now: https://nvidia.github.io/cudaqx/api/qec/cpp_api.html#_CPPv4N5cudaq3qec12surface_code15stabilizer_gridE. We could consider linking to those docs, or adding python bindings for the stabilizer grid tool.

Thanks @justinlietz , that’s a great point! Python bindings do exist, I agree discoverability isn’t very clear right now. I can add cross-references to make this easier to find.

Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants