Add copyright header to qec examples (#125)

melody-ren · web-flow · commit 43dcb617d7ff · 2025-03-14T11:05:41.000-07:00
Signed-off-by: Melody Ren &lt;melodyr@nvidia.com&gt;
diff --git a/docs/sphinx/examples/qec/cpp/circuit_level_noise.cpp b/docs/sphinx/examples/qec/cpp/circuit_level_noise.cpp
@@ -5,7 +5,7 @@
  * This source code and the accompanying materials are made available under    *
  * the terms of the Apache License 2.0 which accompanies this distribution.    *
  ******************************************************************************/
-
+// [Begin Documentation]
 // Compile and run with:
 // nvq++ --enable-mlir --target=stim -lcudaq-qec circuit_level_noise.cpp
 // ./a.out
diff --git a/docs/sphinx/examples/qec/cpp/code_capacity_noise.cpp b/docs/sphinx/examples/qec/cpp/code_capacity_noise.cpp
@@ -5,7 +5,7 @@
  * This source code and the accompanying materials are made available under    *
  * the terms of the Apache License 2.0 which accompanies this distribution.    *
  ******************************************************************************/
-
+// [Begin Documentation]
 // This example shows the primary cudaq::qec types:
 // decoder, code
 //
diff --git a/docs/sphinx/examples/qec/python/circuit_level_noise.py b/docs/sphinx/examples/qec/python/circuit_level_noise.py
@@ -1,3 +1,11 @@
+# ============================================================================ #
+# Copyright (c) 2025 NVIDIA Corporation & Affiliates.                          #
+# All rights reserved.                                                         #
+#                                                                              #
+# This source code and the accompanying materials are made available under     #
+# the terms of the Apache License 2.0 which accompanies this distribution.     #
+# ============================================================================ #
+# [Begin Documentation]
 import numpy as np
 import cudaq
 import cudaq_qec as qec
diff --git a/docs/sphinx/examples/qec/python/code_capacity_noise.py b/docs/sphinx/examples/qec/python/code_capacity_noise.py
@@ -1,3 +1,12 @@
+# ============================================================================ #
+# Copyright (c) 2025 NVIDIA Corporation & Affiliates.                          #
+# All rights reserved.                                                         #
+#                                                                              #
+# This source code and the accompanying materials are made available under     #
+# the terms of the Apache License 2.0 which accompanies this distribution.     #
+# ============================================================================ #
+
+# [Begin Documentation]
 import numpy as np
 import cudaq_qec as qec
 
diff --git a/docs/sphinx/examples/qec/python/pseudo_threshold.py b/docs/sphinx/examples/qec/python/pseudo_threshold.py
@@ -1,3 +1,12 @@
+# ============================================================================ #
+# Copyright (c) 2025 NVIDIA Corporation & Affiliates.                          #
+# All rights reserved.                                                         #
+#                                                                              #
+# This source code and the accompanying materials are made available under     #
+# the terms of the Apache License 2.0 which accompanies this distribution.     #
+# ============================================================================ #
+
+# [Begin Documentation]
 import numpy as np
 import cudaq_qec as qec
 import matplotlib.pyplot as plt
diff --git a/docs/sphinx/examples/qec/python/repetition_code_fine_grain_noise.py b/docs/sphinx/examples/qec/python/repetition_code_fine_grain_noise.py
@@ -1,3 +1,12 @@
+# ============================================================================ #
+# Copyright (c) 2025 NVIDIA Corporation & Affiliates.                          #
+# All rights reserved.                                                         #
+#                                                                              #
+# This source code and the accompanying materials are made available under     #
+# the terms of the Apache License 2.0 which accompanies this distribution.     #
+# ============================================================================ #
+
+# [Begin Documentation]
 import cudaq
 import cudaq_qec as qec
 import numpy as np
diff --git a/docs/sphinx/examples/solvers/cpp/adapt_h2.cpp b/docs/sphinx/examples/solvers/cpp/adapt_h2.cpp
@@ -5,6 +5,7 @@
  * This source code and the accompanying materials are made available under    *
  * the terms of the Apache License 2.0 which accompanies this distribution.    *
  ******************************************************************************/
+// [Begin Documentation]
 #include "cudaq.h"
 #include "cudaq/solvers/adapt.h"
 #include "cudaq/solvers/operators.h"
diff --git a/docs/sphinx/examples/solvers/cpp/molecular_docking_qaoa.cpp b/docs/sphinx/examples/solvers/cpp/molecular_docking_qaoa.cpp
@@ -5,7 +5,7 @@
  * This source code and the accompanying materials are made available under    *
  * the terms of the Apache License 2.0 which accompanies this distribution.    *
  ******************************************************************************/
-
+// [Begin Documentation]
 #include "cudaq.h"
 #include "cudaq/solvers/operators.h"
 #include "cudaq/solvers/qaoa.h"
diff --git a/docs/sphinx/examples/solvers/cpp/uccsd_vqe.cpp b/docs/sphinx/examples/solvers/cpp/uccsd_vqe.cpp
@@ -5,6 +5,7 @@
  * This source code and the accompanying materials are made available under    *
  * the terms of the Apache License 2.0 which accompanies this distribution.    *
  ******************************************************************************/
+// [Begin Documentation]
 #include "cudaq.h"
 #include "cudaq/solvers/operators.h"
 #include "cudaq/solvers/stateprep/uccsd.h"
diff --git a/docs/sphinx/examples/solvers/python/adapt_h2.py b/docs/sphinx/examples/solvers/python/adapt_h2.py
@@ -5,6 +5,8 @@
 # This source code and the accompanying materials are made available under     #
 # the terms of the Apache License 2.0 which accompanies this distribution.     #
 # ============================================================================ #
+
+# [Begin Documentation]
 import cudaq, cudaq_solvers as solvers
 
 # Run this script with
diff --git a/docs/sphinx/examples/solvers/python/generate_molecular_hamiltonians.py b/docs/sphinx/examples/solvers/python/generate_molecular_hamiltonians.py
@@ -6,6 +6,7 @@
 # the terms of the Apache License 2.0 which accompanies this distribution.     #
 # ============================================================================ #
 
+# [Begin Documentation]
 import cudaq_solvers as solvers
 
 # Generate active space Hamiltonian using HF molecular orbitals
diff --git a/docs/sphinx/examples/solvers/python/molecular_docking_qaoa.py b/docs/sphinx/examples/solvers/python/molecular_docking_qaoa.py
@@ -5,6 +5,8 @@
 # This source code and the accompanying materials are made available under     #
 # the terms of the Apache License 2.0 which accompanies this distribution.     #
 # ============================================================================ #
+
+# [Begin Documentation]
 import cudaq, cudaq_solvers as solvers
 import networkx as nx, numpy as np
 
diff --git a/docs/sphinx/examples/solvers/python/uccsd_vqe.py b/docs/sphinx/examples/solvers/python/uccsd_vqe.py
@@ -5,6 +5,8 @@
 # This source code and the accompanying materials are made available under     #
 # the terms of the Apache License 2.0 which accompanies this distribution.     #
 # ============================================================================ #
+
+# [Begin Documentation]
 import cudaq, cudaq_solvers as solvers
 from scipy.optimize import minimize
 
diff --git a/docs/sphinx/examples_rst/qec/circuit_level_noise.rst b/docs/sphinx/examples_rst/qec/circuit_level_noise.rst
@@ -26,11 +26,13 @@ Here's how to use CUDA-Q QEC to perform a circuit-level noise model experiment i
 
    .. literalinclude:: ../../examples/qec/python/circuit_level_noise.py
       :language: python
+      :start-after: [Begin Documentation]
 
 .. tab:: C++
 
    .. literalinclude:: ../../examples/qec/cpp/circuit_level_noise.cpp
       :language: cpp
+      :start-after: [Begin Documentation]
 
    Compile and run with
 
@@ -82,6 +84,7 @@ Addtionally, here's how to use CUDA-Q QEC to construct a multi-round parity chec
 
    .. literalinclude:: ../../examples/qec/python/repetition_code_fine_grain_noise.py
       :language: python
+      :start-after: [Begin Documentation]
 
 This example illustrates how to:
 
diff --git a/docs/sphinx/examples_rst/qec/code_capacity_noise.rst b/docs/sphinx/examples_rst/qec/code_capacity_noise.rst
@@ -36,11 +36,13 @@ Here's how to use CUDA-Q QEC to perform a code capacity noise model experiment i
 
    .. literalinclude:: ../../examples/qec/python/code_capacity_noise.py
       :language: python
+      :start-after: [Begin Documentation]
 
 .. tab:: C++
 
    .. literalinclude:: ../../examples/qec/cpp/code_capacity_noise.cpp
       :language: cpp
+      :start-after: [Begin Documentation]
 
    Compile and run with
 
diff --git a/docs/sphinx/examples_rst/solvers/adapt.rst b/docs/sphinx/examples_rst/solvers/adapt.rst
@@ -25,11 +25,13 @@ Here we demonstrate how to use the CUDA-Q Solvers library to execute the ADAPT-V
 
    .. literalinclude:: ../../examples/solvers/python/adapt_h2.py
       :language: python
+      :start-after: [Begin Documentation]
 
 .. tab:: C++
 
    .. literalinclude:: ../../examples/solvers/cpp/adapt_h2.cpp
       :language: cpp
+      :start-after: [Begin Documentation]
 
    Compile and run with
 
diff --git a/docs/sphinx/examples_rst/solvers/qaoa.rst b/docs/sphinx/examples_rst/solvers/qaoa.rst
@@ -14,11 +14,13 @@ Key features of QAOA:
 
    .. literalinclude:: ../../examples/solvers/python/molecular_docking_qaoa.py
       :language: python
+      :start-after: [Begin Documentation]
 
 .. tab:: C++
 
    .. literalinclude:: ../../examples/solvers/cpp/molecular_docking_qaoa.cpp
       :language: cpp
+      :start-after: [Begin Documentation]
 
    Compile and run with
 
diff --git a/docs/sphinx/examples_rst/solvers/vqe.rst b/docs/sphinx/examples_rst/solvers/vqe.rst
@@ -26,11 +26,13 @@ CUDA-Q Solvers provides a high-level interface for running VQE simulations. Here
 
    .. literalinclude:: ../../examples/solvers/python/uccsd_vqe.py
       :language: python
+      :start-after: [Begin Documentation]
 
 .. tab:: C++
 
    .. literalinclude:: ../../examples/solvers/cpp/uccsd_vqe.cpp
       :language: cpp
+      :start-after: [Begin Documentation]
 
    Compile and run with
 
