Docs preview for PR #741.

pr-741/CMakeLists.txt

@@ -0,0 +1,116 @@
+# ============================================================================ #
+# Copyright (c) 2022 - 2023 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.     #
+# ============================================================================ #
+
+# Add nvq++ compile + execution test of code examples
+# Args:
+#   TEST_NAME: name of the test executable. Test name is prefixed with "nvqpp"
+#   SOURCE_LOCATION: location of the source file (relative to 'sphinx/examples/cpp' directory by default) 
+# Optional keyword args:
+#   TARGET <TARGET_NAME>: name of the target to use
+#   SOURCE_DIR <DIR>: the directory that SOURCE_LOCATION is relative to (if not the default)
+#   LAUNCH_COMMAND <COMMAND>: the command to launch the test (e.g., mpirun)
+function(add_nvqpp_test TEST_NAME SOURCE_LOCATION)
+  cmake_parse_arguments(PARSED_ARGS "" "TARGET;SOURCE_DIR;LAUNCH_COMMAND" "" ${ARGN}) 
+  set(NVQPP_COMPILE_ARGS "")
+  if(PARSED_ARGS_TARGET)
+    set(NVQPP_COMPILE_ARGS "${NVQPP_COMPILE_ARGS} --target ${PARSED_ARGS_TARGET}")
+  endif()
+  if (NOT PARSED_ARGS_SOURCE_DIR)
+    set(PARSED_ARGS_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/sphinx/examples/cpp")
+  endif()
+  add_test(
+  NAME
+    nvqpp_${TEST_NAME}
+  COMMAND
+    bash -c "${CMAKE_BINARY_DIR}/bin/nvq++ ${NVQPP_COMPILE_ARGS} ${PARSED_ARGS_SOURCE_DIR}/${SOURCE_LOCATION} -o ${TEST_NAME} ;\
+              ${PARSED_ARGS_LAUNCH_COMMAND} ${CMAKE_CURRENT_BINARY_DIR}/${TEST_NAME}"
+  )
+endfunction()
+
+add_nvqpp_test(GHZ basics/static_kernel.cpp)
+add_nvqpp_test(MultiControlOps basics/multi_controlled_operations.cpp)
+add_nvqpp_test(ExpVals basics/expectation_values.cpp)
+add_nvqpp_test(MidCircuitMeasurements basics/mid_circuit_measurement.cpp)
+add_nvqpp_test(PhaseEstimation algorithms/phase_estimation.cpp)
+add_nvqpp_test(Grover algorithms/grover.cpp)
+add_nvqpp_test(QAOA algorithms/qaoa_maxcut.cpp)
+add_nvqpp_test(VQEH2 algorithms/vqe_h2.cpp)
+add_nvqpp_test(AmplitudeEstimation algorithms/amplitude_estimation.cpp)
+add_nvqpp_test(Builder other/builder/builder.cpp)
+add_nvqpp_test(QAOABuilder other/builder/qaoa_maxcut_builder.cpp)
+add_nvqpp_test(VQEH2Builder other/builder/vqe_h2_builder.cpp)
+add_nvqpp_test(ComputeAction other/compute_actions.cpp)
+add_nvqpp_test(Gradients other/gradients.cpp)
+add_nvqpp_test(IterativePhaseEstimation other/iterative_qpe.cpp)
+add_nvqpp_test(RandomWalkPhaseEstimation other/random_walk_qpe.cpp)
+
+if (CUSTATEVEC_ROOT AND CUDA_FOUND) 
+  add_nvqpp_test(CuQuantumBackend basics/cuquantum_backends.cpp TARGET nvidia)  
+endif()
+
+# mqpu code snippets, needs custatevec backend and (optionally MPI)
+set(NGPUS 0)
+if (CUSTATEVEC_ROOT AND CUDA_FOUND) 
+  add_nvqpp_test(SampleAsync using/cudaq/platform/sample_async.cpp TARGET nvidia-mqpu SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp)
+  add_nvqpp_test(ObserveMQPU using/cudaq/platform/observe_mqpu.cpp TARGET nvidia-mqpu SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp)
+  # Add the MPI test if MPI was found and there are more than 2 GPUs
+  if (MPI_CXX_FOUND)
+    # Count the number of GPUs
+    find_program(NVIDIA_SMI "nvidia-smi")
+    if(NVIDIA_SMI)
+      execute_process(COMMAND bash -c "nvidia-smi --list-gpus | wc -l" OUTPUT_VARIABLE NGPUS)
+      # Only build this test if we have more than 1 GPU
+      if (${NGPUS} GREATER_EQUAL 2)
+        add_nvqpp_test(ObserveMQPU_MPI using/cudaq/platform/observe_mqpu_mpi.cpp
+                        TARGET nvidia-mqpu 
+                        SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp 
+                        LAUNCH_COMMAND "${MPIEXEC} --allow-run-as-root -np 2")
+      endif()
+    endif(NVIDIA_SMI)  
+  endif()   
+endif()
+
+# Only add the python tests if we built the python API
+if (NOT CUDAQ_ENABLE_PYTHON)
+  return()
+endif()
+
+# And we have the python interpreter
+find_package(Python COMPONENTS Interpreter QUIET)
+if (NOT Python_FOUND)
+  return()
+endif()
+
+function(add_pycudaq_test TEST_NAME SOURCE_LOCATION)
+  cmake_parse_arguments(PARSED_ARGS "" "SOURCE_DIR;LAUNCH_COMMAND" "" ${ARGN}) 
+  if (NOT PARSED_ARGS_SOURCE_DIR)
+    set(PARSED_ARGS_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/sphinx/examples/python")
+  endif()
+  add_test(
+  NAME
+    pycudaq_${TEST_NAME}
+  COMMAND
+    bash -c "${PARSED_ARGS_LAUNCH_COMMAND} ${Python_EXECUTABLE} ${PARSED_ARGS_SOURCE_DIR}/${SOURCE_LOCATION}"
+  )
+endfunction()
+
+add_pycudaq_test(Intro intro.py)
+add_pycudaq_test(BernsteinVazirani bernstein_vazirani.py)
+add_pycudaq_test(QAOA qaoa_maxcut.py)
+add_pycudaq_test(VQE simple_vqe.py)
+add_pycudaq_test(VQEAdvanced advanced_vqe.py)
+
+if (CUSTATEVEC_ROOT AND CUDA_FOUND) 
+  add_pycudaq_test(SampleAsync using/cudaq/platform/sample_async.py SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/python)
+  add_pycudaq_test(ObserveMQPU using/cudaq/platform/observe_mqpu.py SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/python)
+  if (MPI_CXX_FOUND AND ${NGPUS} GREATER_EQUAL 2)
+    add_pycudaq_test(ObserveMQPU_MPI using/cudaq/platform/observe_mqpu_mpi.py 
+                      SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/python
+                      LAUNCH_COMMAND "${MPIEXEC} --allow-run-as-root -np 2")
+  endif()
+endif()