Improve photonics documentation

[Omar-ORCA]

No description provided.

[copy-pr-bot]

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]

/ok to test

Command Bot: Processing...

[github-actions]

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

[khalatepradnya]

/ok to test

Command Bot: Processing...

[github-actions]

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

[khalatepradnya]

@mawolf2023 for reviewing documentation structure.

[mawolf2023]

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 ?

[khalatepradnya]

Thanks, @Omar-ORCA , for the updates!
While you are at it, can you add the following patch?

diff --git a/docs/sphinx/targets/cpp/photonics_tbi_get_state.cpp b/docs/sphinx/targets/cpp/photonics_tbi_get_state.cpp
index 3b27be44f5..0354bd629c 100644
--- a/docs/sphinx/targets/cpp/photonics_tbi_get_state.cpp
+++ b/docs/sphinx/targets/cpp/photonics_tbi_get_state.cpp
@@ -1,6 +1,7 @@
 // Compile and run with:
 // ```
-// nvq++ --target orca-photonics photonics_tbi_get_state.cpp && ./a.out
+// nvq++ --library-mode --target orca-photonics photonics_tbi_get_state.cpp
+// ./a.out
 // ```

 #include <cudaq.h>
diff --git a/docs/sphinx/targets/cpp/photonics_tbi_sample.cpp b/docs/sphinx/targets/cpp/photonics_tbi_sample.cpp
index 90da940ec2..28055ec211 100644
--- a/docs/sphinx/targets/cpp/photonics_tbi_sample.cpp
+++ b/docs/sphinx/targets/cpp/photonics_tbi_sample.cpp
@@ -1,6 +1,7 @@
 // Compile and run with:
 // ```
-// nvq++ --target orca-photonics photonics_tbi_sample.cpp && ./a.out
+// nvq++ --library-mode --target orca-photonics photonics_tbi_sample.cpp
+// ./a.out
 // ```

 #include <cudaq.h>

With CUDA-Q v0.9.1, the library mode isn't default and must be explicitly set.

[khalatepradnya]

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 ?

Thanks, @mawolf2023 for the feedback. I think it may come to which PR gets merged first. Are you close to getting yours in?

[Omar-ORCA]

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 ?

I just wanted to make clear that the photonics simulator is not ORCA specific, it can be used to simulate any photonic circuit.

[github-actions]

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

[khalatepradnya]

/ok to test

Command Bot: Processing...

[github-actions]

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

[khalatepradnya]

/ok to test

Command Bot: Processing...

[github-actions]

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

[khalatepradnya]

/ok to test

Command Bot: Processing...

[github-actions]

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

[khalatepradnya]

/ok to test

Command Bot: Processing...

[github-actions]

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