Set precision cmake

.devcontainer/gpu/Dockerfile

@@ -1,4 +1,4 @@
-FROM nvidia/cuda:12.2.0-devel-ubuntu22.04
+FROM nvidia/cuda:12.6.1-devel-ubuntu22.04
 
 ENV DEBIAN_FRONTEND=noninteractive
 

.devcontainer/gpu/devcontainer.json

@@ -31,10 +31,10 @@
 				"python.terminal.activateEnvironment": false,
 				// CAVEAT: you need to restart after building scaluq to take effect.
 				"C_Cpp.default.includePath": [
-					"scaluq",
+					"include",
 					"/usr/local/include/kokkos",
-					"build/_deps/eigen_fetch-src",
-					"build/_deps/googletest_fetch-src/googletest/include",
+					"build/_deps/eigen-src",
+					"build/_deps/googletest-src/googletest/include",
 					"~/.local/lib/python3.10/site-packages/nanobind/include",
 					"/usr/include/python3.10"
 				],

.github/workflows/install.yml

@@ -0,0 +1,163 @@
+name: Install to System
+
+on:
+  push:
+    paths-ignore:
+      - ".devcontainer/**"
+      - ".vscode/**"
+      - "doc/**"
+      - "*.md"
+  pull_request:
+    paths-ignore:
+      - ".devcontainer/**"
+      - ".vscode/**"
+      - "doc/**"
+      - "*.md"
+
+jobs:
+  library:
+    name: Install Library
+    strategy:
+      matrix:
+        os: ["linux", "macos"]
+        architecture: ["x86_64", "arm64"]
+        device: ["cpu", "cuda"]
+        exclude:
+          - os: "macos"
+            device: "cuda"
+          # currently ARM runner is not supported
+          - os: "linux"
+            architecture: "arm64"
+        include:
+          - os: "linux"
+            architecture: "x86_64"
+            runs-on: "ubuntu-22.04"
+          - os: "macos"
+            architecture: "x86_64"
+            runs-on: "macos-13"
+          - os: "macos"
+            architecture: "arm64"
+            runs-on: "macos-14"
+    runs-on: ${{ matrix.runs-on }}
+    env:
+      CMAKE_C_COMPILER: ${{ matrix.runs-on == 'macos-13' && '/usr/local/opt/ccache/libexec/gcc-14'|| matrix.runs-on == 'macos-14' && '/opt/homebrew/opt/ccache/libexec/gcc-14' || '/usr/lib/ccache/gcc' }}
+      CMAKE_CXX_COMPILER: ${{ matrix.runs-on == 'macos-13' && '/usr/local/opt/ccache/libexec/g++-14'|| matrix.runs-on == 'macos-14' && '/opt/homebrew/opt/ccache/libexec/g++-14' || '/usr/lib/ccache/g++' }}
+      SCALUQ_USE_CUDA: ${{ matrix.device == 'cuda' && 'ON' || 'OFF' }}
+      SCALUQ_CUDA_ARCH: "PASCAL61"
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Ninja
+        if: ${{ matrix.os == 'linux' }}
+        run: sudo apt update && sudo apt install ninja-build
+
+      - name: Install Ninja
+        if: ${{ matrix.os == 'macos' }}
+        run: brew install ninja
+
+      - name: Setup ccache
+        uses: hendrikmuhs/[email protected]
+        with:
+          key: "${{ github.job }}-${{ matrix.os }}-${{ matrix.architecture }}-${{ matrix.device }}"
+          verbose: 2
+
+      - name: Install CUDA toolkit
+        if: ${{ matrix.device == 'cuda' }}
+        uses: Jimver/[email protected]
+        with:
+          cuda: "12.6.1"
+          method: "network"
+
+      - name: Show installed Compiler version
+        run: |
+          [ $SCALUQ_USE_CUDA = 'ON' ] && nvcc --version
+          ccache --version
+          $CMAKE_C_COMPILER --version
+          $CMAKE_CXX_COMPILER --version
+          cmake --version
+          ninja --version
+
+      - name: Configure
+        run: ./script/configure
+
+      - name: Install to system
+        run: sudo -E env "PATH=$PATH" ninja -C build install
+
+      - name: Build and Run other project
+        run: |
+          cd example_project/
+          cmake -B build/ -D "CMAKE_C_COMPILER=$CMAKE_C_COMPILER" -D "CMAKE_CXX_COMPILER=$CMAKE_CXX_COMPILER" -D "SCALUQ_USE_CUDA=$SCALUQ_USE_CUDA"
+          make -C build
+          if [ "$SCALUQ_USE_CUDA" != 'ON']; then
+            build/main
+          fi
+
+  python:
+    name: Install Python package
+    strategy:
+      matrix:
+        os: ["linux", "macos"]
+        architecture: ["x86_64", "arm64"]
+        device: ["cpu", "cuda"]
+        python-version: ["3.12"]
+        exclude:
+          - os: "macos"
+            device: "cuda"
+          # currently ARM runner is not supported
+          - os: "linux"
+            architecture: "arm64"
+        include:
+          - os: "linux"
+            architecture: "x86_64"
+            runs-on: "ubuntu-22.04"
+          - os: "macos"
+            architecture: "x86_64"
+            runs-on: "macos-13"
+          - os: "macos"
+            architecture: "arm64"
+            runs-on: "macos-14"
+    runs-on: ${{ matrix.runs-on }}
+    env:
+      CMAKE_C_COMPILER: ${{ matrix.runs-on == 'macos-13' && '/usr/local/opt/ccache/libexec/gcc-14'|| matrix.runs-on == 'macos-14' && '/opt/homebrew/opt/ccache/libexec/gcc-14' || '/usr/lib/ccache/gcc' }}
+      CMAKE_CXX_COMPILER: ${{ matrix.runs-on == 'macos-13' && '/usr/local/opt/ccache/libexec/g++-14'|| matrix.runs-on == 'macos-14' && '/opt/homebrew/opt/ccache/libexec/g++-14' || '/usr/lib/ccache/g++' }}
+      SCALUQ_USE_CUDA: ${{ matrix.device == 'cuda' && 'ON' || 'OFF' }}
+      SCALUQ_CUDA_ARCH: "PASCAL61"
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup ccache
+        uses: hendrikmuhs/[email protected]
+        with:
+          key: "${{ github.job }}-${{ matrix.os }}-${{ matrix.architecture }}-${{ matrix.device }}"
+          verbose: 2
+
+      - name: Install CUDA toolkit
+        if: ${{ matrix.device == 'cuda' }}
+        uses: Jimver/[email protected]
+        with:
+          cuda: "12.6.1"
+          method: "network"
+
+      - name: Show installed Compiler version
+        run: |
+          [ $SCALUQ_USE_CUDA = 'ON' ] && nvcc --version
+          ccache --version
+          $CMAKE_C_COMPILER --version
+          $CMAKE_CXX_COMPILER --version
+
+      - name: Install mypy
+        run: python -m pip install mypy
+
+      - name: Install to system
+        run: python -m pip install .
+
+      - name: Run / Test stub
+        if: ${{ matrix.device == 'cpu' }} # currently GPU runner is not supported
+        run: |
+          echo -e "from scaluq.f64 import StateVector, gate\nstate = StateVector(2)\nx = gate.X(0)\nx.update_quantum_state(state)\nprint(state.get_amplitudes())" > /tmp/sample.py
+          python /tmp/sample.py
+          python -m mypy /tmp/sample.py

.github/workflows/test.yml

@@ -22,7 +22,6 @@ jobs:
         os: ["linux", "macos"]
         architecture: ["x86_64", "arm64"]
         device: ["cpu", "cuda"]
-        python-version: ["3.10"]
         exclude:
           - os: "macos"
             device: "cuda"
@@ -66,9 +65,9 @@ jobs:
 
       - name: Install CUDA toolkit
         if: ${{ matrix.device == 'cuda' }}
-        uses: Jimver/[email protected].11
+        uses: Jimver/[email protected].19
         with:
-          cuda: "12.2.0"
+          cuda: "12.6.1"
           method: "network"
 
       - name: Show installed Compiler version
@@ -83,9 +82,6 @@ jobs:
       - name: Install scaluq for Ubuntu
         run: ./script/build_gcc.sh
 
-      - name: Install scaluq Python module
-        run: pip install .[ci]
-
       - name: Test in Ubuntu
         if: ${{ matrix.device == 'cpu' }} # currently GPU runner is not supported
         run: |
@@ -95,9 +91,3 @@ jobs:
             NPROC=$(nproc)
           fi
           OMP_PROC_BIND=false ninja test -C build -j ${NPROC}
-
-      - name: Test if stub exists
-        if: ${{ matrix.device == 'cpu' }} # currently GPU runner is not supported
-        run: |
-          echo -e "from scaluq import StateVector\nfrom scaluq.gate import I" > /tmp/stub_sample.py
-          mypy /tmp/stub_sample.py

.gitignore

@@ -43,3 +43,4 @@
 /doc/build/
 /python/scaluq/_version.py
 /kokkos-tools
+/example_project/build/

CMakeLists.txt

@@ -12,10 +12,10 @@ if(NOT DEFINED SCALUQ_USE_CUDA)
     set(SCALUQ_USE_CUDA OFF)
 endif(NOT DEFINED SCALUQ_USE_CUDA)
 if(NOT DEFINED SCALUQ_USE_TEST)
-    set(SCALUQ_USE_TEST ON)
+    set(SCALUQ_USE_TEST OFF)
 endif(NOT DEFINED SCALUQ_USE_TEST)
 if(NOT DEFINED SCALUQ_USE_EXE)
-    set(SCALUQ_USE_EXE ON)
+    set(SCALUQ_USE_EXE OFF)
 endif(NOT DEFINED SCALUQ_USE_EXE)
 
 message(STATUS "SKBUILD = ${SKBUILD}")
@@ -135,7 +135,7 @@ if ((${CMAKE_CXX_COMPILER_ID} STREQUAL "GNU") OR (${CMAKE_CXX_COMPILER_ID} STREQ
 endif()
 
 ### Add subdirectories ###
-add_subdirectory(scaluq)
+add_subdirectory(src)
 if(SKBUILD)
     add_subdirectory(python)
 endif(SKBUILD)

README.md

@@ -12,35 +12,42 @@ scaluq は、量子回路シミュレータ [Qulacs](https://github.com/qulacs/q
 - [nanobind](https://github.com/wjakob/nanobind) の導入により、よりコンパクトかつ高速な Python へのバインディングを実現します。
 - 複数の量子状態に対して同じ回路を適用させるようなケースに対して、より高速なインターフェースを提供します（未実装）。
 
-## 依存ライブラリ
+## ビルド時要件
 
 - Ninja 1.10 以上
 - GCC 11 以上
 - CMake 3.21 以上
-- CUDA 12.2 以上（GPU利用時のみ）
+- CUDA 12.6 以上（GPU利用時のみ）
+※これより低いバージョンでも動作する可能性はありますが確認していません
+
+## 実行時要件
+- CUDA 12.6 以上（GPU利用時のみ）
+※これより低いバージョンでも動作する可能性はありますが確認していません
 
 ## C++ ライブラリとしてインストール
 
-Qulacs2023 を静的ライブラリとしてインストールするには、以下の一連のコマンドを実行します。
+scaluq を静的ライブラリとしてインストールするには、以下の一連のコマンドを実行します。
 
 ```txt
 git clone https://github.com/qulacs/scaluq
 cd scaluq
-./script/build_gcc.sh
+script/configure
+sudo -E env "PATH=$PATH" ninja -C build install
 ```
 
-NVIDIA GPU と CUDA が利用可能ならば、以下のコマンドで GPU バージョンをインストールできます。ビルドスクリプトの実行の際に `SCALUQ_USE_CUDA` オプションを付けます。
+- 依存ライブラリのEigenとKokkosも同時にインストールされます
+- `CMAKE_INSTALL_PREFIX`を設定することで `/usr/local`以外にインストールすることもできます。ユーザーローカルにインストールしたい場合や、別の設定でビルドしたKokkosと衝突させたくない場合は明示的に指定してください。例: `CMAKE_INSTALL_PREFIX=~/.local script/configure; ninja -C build install`
+- ビルドしたものを`/usr/local/bin`に配置するため`sudo`コマンドを用いていますが、ビルド時の環境変数をユーザーのものにするため例では`-E`と`env "PATH=$PATH"`を指定しています。
+- NVIDIA GPU と CUDA が利用可能ならば、`SCALUQ_USE_CUDA=Yes`を設定してconfigureすることでCUDAを利用するライブラリとしてインストールできます。例: `SCALUQ_USE_CUDA=Yes script/configure; sudo env -E "PATH=$PATH" ninja -C build install'`
 
-```txt
-SCALUQ_USE_CUDA=ON ./script/build_gcc.sh
-```
-
-ただし、オプションを変更して再ビルドする際には、CMake にセットされたキャッシュ変数をクリアするため、必ず以下のコマンドを実行してください。
+オプションを変更して再ビルドする際には、CMake にセットされたキャッシュ変数をクリアするため、必ず以下のコマンドを実行してください。
 
 ```txt
 rm build/CMakeCache.txt
 ```
 
+インストール済みのscaluqを利用したプロジェクトでのCMake設定例を[example_project/](example_project/CMakeLists.txt)に提示しています。
+
 ## Python ライブラリとしてインストール
 Python のライブラリとしても使用することができます。
 ```txt
@@ -65,26 +72,26 @@ https://scaluq.readthedocs.io/en/latest/index.html
 #include <iostream>
 #include <cstdint>
 
-#include <circuit/circuit.hpp>
-#include <gate/gate_factory.hpp>
-#include <operator/operator.hpp>
-#include <state/state_vector.hpp>
+#include <scaluq/circuit/circuit.hpp>
+#include <scaluq/gate/gate_factory.hpp>
+#include <scaluq/operator/operator.hpp>
+#include <scaluq/state/state_vector.hpp>
 
 int main() {
     scaluq::initialize();  // must be called before using any scaluq methods
     {
         const std::uint64_t n_qubits = 3;
-        scaluq::StateVector state = scaluq::StateVector::Haar_random_state(n_qubits, 0);
+        scaluq::StateVector<double> state = scaluq::StateVector::Haar_random_state(n_qubits, 0);
         std::cout << state << std::endl;
 
-        scaluq::Circuit circuit(n_qubits);
+        scaluq::Circuit<double> circuit(n_qubits);
         circuit.add_gate(scaluq::gate::X(0));
         circuit.add_gate(scaluq::gate::CNot(0, 1));
         circuit.add_gate(scaluq::gate::Y(1));
         circuit.add_gate(scaluq::gate::RX(1, std::numbers::pi / 2));
         circuit.update_quantum_state(state);
 
-        scaluq::Operator observable(n_qubits);
+        scaluq::Operator<double> observable(n_qubits);
         observable.add_random_operator(1, 0);
         auto value = observable.get_expectation_value(state);
         std::cout << value << std::endl;
@@ -96,7 +103,7 @@ int main() {
 ## サンプルコード(Python)
 
 ```Python
-from scaluq import *
+from scaluq.f64 import *
 import math
 
 n_qubits = 3
@@ -115,3 +122,14 @@ value = observable.get_expectation_value(state)
 print(value)
 
 ```
+
+# 精度指定について
+scaluqでは、計算に使用する浮動小数点数のサイズとして32bitと64bitが選択できます。
+通常は64bitの使用が推奨されますが、量子機械学習での利用などあまり精度が必要でない場合は32bitを使用すると最大2倍程度の高速化が見込めます。
+
+同じ精度のオブジェクト同士でしか演算を行うことができません。
+例えば32bit用に作成したゲートでは64bitの`StateVector`を更新できません。
+
+C++の場合、状態、ゲート、演算子、回路のクラスやゲートを生成する関数が、テンプレート引数を取るようになっており、そこに`float`または`double`を指定することで選択します。
+
+Pythonの場合、精度に合わせて`scaluq.f32`と`scaluq.f64`のどちらかのサブモジュールからオブジェクトを`import`します。

example_project/CMakeLists.txt

@@ -0,0 +1,19 @@
+cmake_minimum_required(VERSION 3.21)
+
+project(example)
+
+find_package(OpenMP)
+if(SCALUQ_USE_CUDA)
+    find_package(CUDAToolkit)
+endif()
+find_package(Kokkos)
+find_package(scaluq)
+add_executable(main main.cpp)
+target_include_directories(main PUBLIC /usr/local/include/scaluq)
+target_include_directories(main PUBLIC /usr/local/include/kokkos)
+target_include_directories(main PUBLIC /usr/local/include/eigen3)
+target_compile_features(main PUBLIC cxx_std_20)
+target_compile_options(main PUBLIC -fopenmp)
+target_compile_definitions(main PUBLIC OPENMP)
+target_link_libraries(main PUBLIC scaluq::scaluq)
+

example_project/main.cpp

@@ -0,0 +1,10 @@
+#include <scaluq/state/state_vector.hpp>
+
+int main() {
+    scaluq::initialize();
+    {
+        scaluq::StateVector<double> state(2);
+        std::cout << state << std::endl;
+    }
+    scaluq::finalize();
+}