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.

Sign up for GitHub

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

Jump to bottom

Improve photonics documentation #2502

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Improve photonics documentation #2502

wants to merge 9 commits into from

Conversation

Omar-ORCA
Copy link
Contributor

No description provided.

@copy-pr-bot copy-pr-bot
Copy link

copy-pr-bot bot commented Jan 10, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@schweitzpgi
Copy link
Collaborator

schweitzpgi commented Jan 10, 2025 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@github-actions GitHub Actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jan 10, 2025
@cuda-quantum-bot
Docs preview for PR #2502.
d0c1b38
@Omar-ORCA
formatting and spelling
44c9a4c 
Signed-off-by: Omar Bacarreza <[email protected]>
@Omar-ORCA Omar-ORCA force-pushed the photonics_docs branch 2 times, most recently from a3177c8 to 44c9a4c Compare January 13, 2025 11:34
@Omar-ORCA Omar-ORCA marked this pull request as draft January 13, 2025 11:36
@Omar-ORCA Omar-ORCA marked this pull request as ready for review January 14, 2025 09:27
@khalatepradnya
Copy link
Collaborator

khalatepradnya commented Jan 16, 2025 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@khalatepradnya khalatepradnya added the documentation Improvements or additions to documentation label Jan 16, 2025
@github-actions GitHub Actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jan 16, 2025
@cuda-quantum-bot
Docs preview for PR #2502.
2461da5
@khalatepradnya
Copy link
Collaborator

@mawolf2023 for reviewing documentation structure.

@mawolf2023
Copy link
Contributor

Wow, tricky to decide where to sort this in the docs. I could see a case made to list the photonics simulator with the other simulators. However, my gut thinks we group all of this new material under photonics, especially if it is an ORCA specific simulator. So in the reorganized backends , we have ORCA under the hardware->photonics tab. I say we let this photonics page introduce the orca simulator and show all of the examples. Then the example notebook in this PR could be transformed a bit into a simple application that shows the utility of the photonics simulator. That way it dose not get buried that CUDA-Q can now simulator photonics, but avoids confusing the backend or example sections. Thoughts @efratshabtai @khalatepradnya ?

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

@bettinaheim bettinaheim Awaiting requested review from bettinaheim bettinaheim is a code owner

@1tnguyen 1tnguyen Awaiting requested review from 1tnguyen 1tnguyen is a code owner

@bmhowe23 bmhowe23 Awaiting requested review from bmhowe23 bmhowe23 is a code owner

@schweitzpgi schweitzpgi Awaiting requested review from schweitzpgi schweitzpgi is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Omar-ORCA @schweitzpgi @khalatepradnya @mawolf2023