Added gate decomposition documentation. by vinayswamik · Pull Request #237 · qBraid/pyqasm

vinayswamik · 2025-07-26T07:59:08Z

Summary of changes

Extracted all gate decomposition diagrams and explanations from src/pyqasm/maps/gates.py into docs/gate_decompositions.md.
Updated gates.py to reference the relevant section in the Markdown documentation using direct GitHub URLs for each gate decomposition.
Updated README.md to reference the new gate decompositions documentation.
Ensured all navigation between code and documentation is clear and works in GitHub and standard Markdown previewers.

Closes #190

codecov-commenter · 2025-07-26T08:04:28Z

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/pyqasm/maps/gates.py	0.00%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

TheGupta2012

Changes look good @vinayswamik! On a second glance through the maps, I see that we are missing some decompositions. Can you add the Qiskit decompositions for them in the gate_decompositions.md file as well and the back links in maps.py? This is the missing gate list -

[ u3, cy, zz, cswap, pswap, iswap, rxx, rccx, cphaseshift[00, 10, 01], ecr]

TheGupta2012 · 2025-07-28T06:37:04Z

I'm still seeing the empty logo @vinayswamik with your file but if I add a new qBraid logo , it appears in the docs. Can you figure out why that's happening?

vinayswamik · 2025-07-28T18:32:09Z

Changes look good @vinayswamik! On a second glance through the maps, I see that we are missing some decompositions. Can you add the Qiskit decompositions for them in the gate_decompositions.md file as well and the back links in maps.py? This is the missing gate list -

[ u3, cy, zz, cswap, pswap, iswap, rxx, rccx, cphaseshift[00, 10, 01], ecr]

do you mean gates.py. i didn't see any maps.py file in pyqasm. or do you want me to create new file...?.

And also, some of these gate decompositions are seems different in qiskit as per my observation.

TheGupta2012 · 2025-07-29T08:03:52Z

Changes look good @vinayswamik! On a second glance through the maps, I see that we are missing some decompositions. Can you add the Qiskit decompositions for them in the gate_decompositions.md file as well and the back links in maps.py? This is the missing gate list -
[ u3, cy, zz, cswap, pswap, iswap, rxx, rccx, cphaseshift[00, 10, 01], ecr]

do you mean gates.py. i didn't see any maps.py file in pyqasm. or do you want me to create new file...?.

And also, some of these gate decompositions are seems different in qiskit as per my observation.

Sorry for that confusion, I meant the gates.py file. As for the decompositions absent in Qiskit, some of them might have been taken from the basis gate sets of IQM and Rigetti Devices

TheGupta2012 · 2025-07-29T08:04:21Z

Can you also see why the CI tests are failing?

Edit : turns out it was a 503 server error , re-running the jobs fixed it

TheGupta2012 · 2025-07-29T08:09:38Z

+
+## [CPhaseShift00 Gate](../src/pyqasm/maps/gates.py#L568)
+
+The controlled phase shift 00 gate is implemented using the following qiskit decomposition:


Add decompositions for 00, 01, 10

TheGupta2012 · 2025-07-30T05:31:56Z

Hi @vinayswamik , changes lgtm. Once you add the decompositions for the above mentioned 4 gates, can merge

…DME.md

…, RXX, RCCX, ECR, and controlled phase shift gates in the documentation.

…1,10] gates.

github-actions · 2025-09-11T13:03:02Z

🚫 Logo Change Blocked

Changes to docs/_static/logo.png are not allowed in pull requests.

Why is this blocked?

The logo is a protected asset that should only be updated by repository maintainers
This helps maintain brand consistency and prevents unauthorized logo changes

What should you do?

Remove the logo.png changes from this PR
If you need to update the logo, please contact the repository maintainers directly

Files changed in this PR:

Unable to retrieve changed files

github-actions · 2025-09-11T13:08:52Z

🚫 Logo Change Blocked

Changes to docs/_static/logo.png are not allowed in pull requests.

Why is this blocked?

The logo is a protected asset that should only be updated by repository maintainers
This helps maintain brand consistency and prevents unauthorized logo changes

What should you do?

Remove the logo.png changes from this PR
If you need to update the logo, please contact the repository maintainers directly

Files changed in this PR:

Unable to retrieve changed files

github-actions · 2025-09-11T13:09:26Z

🚫 Logo Change Blocked

Changes to docs/_static/logo.png are not allowed in pull requests.

Why is this blocked?

The logo is a protected asset that should only be updated by repository maintainers
This helps maintain brand consistency and prevents unauthorized logo changes

What should you do?

Remove the logo.png changes from this PR
If you need to update the logo, please contact the repository maintainers directly

Files changed in this PR:

Unable to retrieve changed files

github-actions · 2025-09-11T13:33:19Z

🚫 Logo Change Blocked

Changes to docs/_static/logo.png are not allowed in pull requests.

Why is this blocked?

The logo is a protected asset that should only be updated by repository maintainers
This helps maintain brand consistency and prevents unauthorized logo changes

What should you do?

Remove the logo.png changes from this PR
If you need to update the logo, please contact the repository maintainers directly

Files changed in this PR:

Unable to retrieve changed files

TheGupta2012 · 2025-09-11T13:44:01Z

Closing as #266 is merged

vinayswamik requested a review from TheGupta2012 as a code owner July 26, 2025 07:59

vinayswamik requested review from TheGupta2012 and removed request for TheGupta2012 July 26, 2025 07:59

TheGupta2012 requested changes Jul 28, 2025

View reviewed changes

vinayswamik requested a review from TheGupta2012 July 28, 2025 23:19

vinayswamik force-pushed the docs/update branch from e9c6f32 to b8fbb7c Compare July 29, 2025 00:38

vinayswamik assigned vinayswamik and unassigned vinayswamik Jul 29, 2025

vinayswamik changed the title ~~update logo and added gate decomposition documentation.~~ Added gate decomposition documentation. Jul 29, 2025

TheGupta2012 reviewed Jul 29, 2025

View reviewed changes

Comment thread docs/gate_decompositions.md

TheGupta2012 reviewed Jul 29, 2025

View reviewed changes

vinayswamik requested a review from TheGupta2012 July 30, 2025 21:17

vinayswamik and others added 8 commits September 11, 2025 18:10

update logo and added gate decomposition documentation and update REA…

a0a93fa

…DME.md

removed logo.png

1b2a5be

update logo.png

0061788

edit alt text

c4bdc56

Added detailed decomposition for U3, CY, ZZ, Phaseshift, CSWAP, iSWAP…

c13aa15

…, RXX, RCCX, ECR, and controlled phase shift gates in the documentation.

update CHANGELOG.md

15f183a

Added Qiskit decompositions for PSWAP and controlled phase shift[00,0…

83b8e8c

…1,10] gates.

finalize cphaseshift decompositions

1aff813

TheGupta2012 force-pushed the docs/update branch from 6aed2e4 to 1aff813 Compare September 11, 2025 13:02

restore logo

1c35f28

update logo check to cater to force pushes as well

47d2a4e

TheGupta2012 mentioned this pull request Sep 11, 2025

Gate docs update #266

Merged

TheGupta2012 closed this Sep 11, 2025

vinayswamik deleted the docs/update branch September 12, 2025 17:05


		## [CPhaseShift00 Gate](../src/pyqasm/maps/gates.py#L568)

		The controlled phase shift 00 gate is implemented using the following qiskit decomposition:

Conversation

vinayswamik commented Jul 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Uh oh!

codecov-commenter commented Jul 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TheGupta2012 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheGupta2012 commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vinayswamik commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheGupta2012 commented Jul 29, 2025

Uh oh!

TheGupta2012 commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

TheGupta2012 Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

TheGupta2012 commented Jul 30, 2025

Uh oh!

github-actions bot commented Sep 11, 2025

Uh oh!

github-actions bot commented Sep 11, 2025

Uh oh!

github-actions bot commented Sep 11, 2025

Uh oh!

github-actions bot commented Sep 11, 2025

Uh oh!

TheGupta2012 commented Sep 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vinayswamik commented Jul 26, 2025 •

edited

Loading

codecov-commenter commented Jul 26, 2025 •

edited

Loading

TheGupta2012 left a comment •

edited

Loading

TheGupta2012 commented Jul 28, 2025 •

edited

Loading

vinayswamik commented Jul 28, 2025 •

edited

Loading

TheGupta2012 commented Jul 29, 2025 •

edited

Loading