Skip to content

Conversation

@Rutuja123-dos
Copy link
Contributor

@Rutuja123-dos Rutuja123-dos commented Dec 28, 2025

Purpose of PR

This PR adds documentation describing how NumPy arrays are used
to represent quantum state vectors in QDP.

It includes:

  • State vector structure and dtype
  • A simple NumPy example
  • Notes on usage in simulation backends and tests

Fixes #723.

Related Issues or PRs

Closes #723

Changes Made

  • Bug fix
  • New feature
  • Refactoring
  • Documentation
  • Test
  • CI/CD pipeline
  • Other

Breaking Changes

  • Yes
  • No

Checklist

  • Added or updated unit tests for all changes
  • Added or updated documentation for all changes
  • Successfully built and ran all unit tests or manual tests locally
  • PR title follows "MAHOUT-XXX: Brief Description" format (if related to an issue)
  • Code follows ASF guidelines

@rich7420 rich7420 added the qdp label Dec 29, 2025
@github-project-automation github-project-automation bot moved this to Backlog in QDP Dec 29, 2025
@rich7420 rich7420 changed the title Add NumPy state vector documentation to QDP API [QDP] Add NumPy state vector documentation to QDP API Dec 29, 2025
@rich7420
Copy link
Contributor

cc @ryankert01

@ryankert01
Copy link
Contributor

ryankert01 commented Dec 29, 2025

@rich7420 I don't think numpy pr is merged or created right now
btw, I think it should merge to dev-qdp instead of main.

@rich7420
Copy link
Contributor

agree. I think we could turn into draft waiting for numpy reader being merged.

@rich7420 rich7420 marked this pull request as draft December 29, 2025 02:12
@400Ping
Copy link

400Ping commented Dec 29, 2025

Btw you may need to reopen a pr to target it to dev-qdp

@Rutuja123-dos Rutuja123-dos marked this pull request as ready for review December 29, 2025 05:37
@Rutuja123-dos
Copy link
Contributor Author

Thank you for the guidance.
I understand that this documentation should target dev-qdp and may depend on the NumPy reader being merged first.
I’ll reopen a new PR against dev-qdp once the relevant changes are ready.
Thanks for your time and review.

@rich7420
Copy link
Contributor

@Rutuja123-dos thanks for the patch!

@400Ping
Copy link

400Ping commented Dec 29, 2025

And please ask if someone is doing this before pushing a pr, it is not polite to just take over.

@Rutuja123-dos
Copy link
Contributor Author

Thank you for pointing that out
I’m sorry about that.
I should have checked and coordinated first before pushing the PR.
I’ll make sure to ask on the issue or mailing list before working on similar changes next time.
Thanks for the guidance and review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

[QDP] Add NumPy input documentation and more test

4 participants