Merge pull request #17 from CExA-project/refactor_projects

Refactor projects

Author: pzehner

.github/workflows/exercises.yml

@@ -19,14 +19,14 @@ jobs:
     steps:
       - name: Set up Git repository
         uses: actions/checkout@v4
-      - name: Prepare all exercices and solutions with the OpenMP backend
+      - name: Prepare all exercices with the OpenMP backend
         run: |
           cmake \
             -B build \
             -DCMAKE_BUILD_TYPE=Release \
             -DKokkos_ENABLE_OPENMP=ON \
             exercises
-      - name: Build all exercises and solutions
+      - name: Build all exercises
         run: |
           cmake \
             --build build \

.github/workflows/projects.yml

@@ -5,8 +5,6 @@
 
 name: Test projects
 
-run-name: Test projects
-
 on:
   pull_request:
     branches:
@@ -16,59 +14,29 @@ on:
 
 jobs:
 
-  build_kokkos:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Set up Git repository
-        uses: actions/checkout@v4
-      - name: Install Kokkos
-        run: |
-          git clone https://github.com/kokkos/kokkos.git
-          cd kokkos
-          git checkout develop
-          mkdir build_openmp
-          mkdir install_openmp
-          cmake -B build_openmp  -DCMAKE_INSTALL_PREFIX=${PWD}/install_openmp -DKokkos_ENABLE_OPENMP=ON ./
-          make install -C build_openmp
-      - name: Upload Kokkos artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: kokkos
-          path: kokkos/install_openmp
-
-  build_wave_projects:
+  build_test_projects:
     runs-on: ubuntu-latest
-    needs: [build_kokkos]
     steps:
       - name: Set up Git repository
         uses: actions/checkout@v4
-      - name: Download Kokkos artifact
-        uses: actions/download-artifact@v4
-        with:
-          name: kokkos
-          path: kokkos/install_openmp
-      - name: wave sequential
+      - name: Prepare all projects with the OpenMP backend
         run: |
-          cd projects/wave/sequential/
-          cmake -DCMAKE_BUILD_TYPE=Release ./
-          make
-          ./exe
-          cd ${GITHUB_WORKSPACE}
-      - name: wave openMP
+          cmake \
+            -B build \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DKokkos_ENABLE_OPENMP=ON \
+            projects
+      - name: Build all projects
         run: |
-          cd projects/wave/omp
-          cmake -DCMAKE_BUILD_TYPE=Release ./
-          make
-          export OMP_NUM_THREADS=2
-          export OMP_PROC_BIND=true
-          export OMP_SCHEDULER=dynamic
-          ./exe --size 128 128 --time 5 --output-period 100 --print-period 100 --domain-length 10 10 --boundary 1
-          cd ${GITHUB_WORKSPACE}
-      - name: wave Kokkos
+          cmake \
+            --build build \
+            --parallel $(($(nproc) * 2 + 1))
+      - name: Test all solutions and reference implementations
+        env:
+          OMP_PROC_BIND: spread
+          OMP_PLACES: threads
+          OMP_NUM_THREADS: 2
         run: |
-          cd projects/wave/solution/
-          cmake -DCMAKE_BUILD_TYPE=Release -DKokkos_DIR=${GITHUB_WORKSPACE}/kokkos/install_openmp/lib/cmake/Kokkos/ ./
-          make
-          ./exe --size 128 128 --time 5 --output-period 100 --print-period 100 --domain-length 10 10 --boundary 1
-          cd ${GITHUB_WORKSPACE}
-  
+          ctest \
+            --test-dir build \
+            --output-on-failure

.gitmodules

@@ -1,4 +1,4 @@
-[submodule "exercises/vendor/kokkos"]
-	path = exercises/vendor/kokkos
+[submodule "vendor/kokkos"]
+	path = vendor/kokkos
 	url = https://github.com/kokkos/kokkos
 	branch = master

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Contributing to the tutorials
 
-## Add a new exercise
+## Add a new exercise or a new project
 
-### Exercise structure
+### Directory structure
 
 ```
 new_exercise/
@@ -18,14 +18,14 @@ new_exercise/
 
 ### Testing
 
-Exercises should be tested in the CI.
-To do so, edit `exercises/CMakeLists.txt` to append your exercise directory with `add_subdirectory`:
+Exercises and projects should be tested in the CI.
+To do so, edit `exercises/CMakeLists.txt` or `projects/CMakeLists.txt` to append your exercise directory with `add_subdirectory`:
 
 ```cmake
 add_subdirectory(my_exercise)
 ```
 
-In your `solution/CMakeLists.txt`, add your solution target as a test.
+In your `solution/CMakeLists.txt` (or any build you want to test), add your solution target as a test.
 
 ```cmake
 add_test(
@@ -34,4 +34,6 @@ add_test(
 )
 ```
 
+You can customise the `COMMAND` with any extra arguments for the test.
+
 The new exercise will be automatically built and tested by the CI.

README.md

@@ -32,7 +32,7 @@ This course is part of the [CExA project](https://cexa-project.github.io/).
 
 ### Projects
 
-- [Project 1: Wave Propagation](projects/wave/README.md)
+- [Project 1: Wave Propagation](projects/01_wave/README.md)
 
 ## Get the repository
 

exercises/cmake/modules/FindKokkos.cmake renamed to cmake/modules/FindKokkos.cmake

@@ -28,7 +28,7 @@ endif()
 # find Kokkos as an existing source directory
 set(
     CexaKokkosTutorials_KOKKOS_SOURCE_DIR
-    "${CMAKE_CURRENT_SOURCE_DIR}/../../vendor/kokkos"
+    "${CMAKE_CURRENT_SOURCE_DIR}/../../../vendor/kokkos"
     CACHE
     PATH
     "Path to the local source directory of Kokkos"

exercises/00_compiling_kokkos/README.md

@@ -30,8 +30,8 @@ mv kokkos-4.5.01 kokkos
 
 ### Use the submodule
 
-The `../vendor/kokkos` directory contains Kokkos as a Git submodule.
-If you haven't cloned the repository recursively, you can get it with:
+The `../../../vendor/kokkos` directory contains Kokkos as a Git submodule.
+If you haven't cloned the repository recursively already, you can get it with:
 
 ```sh
 git submodule update --init
@@ -40,7 +40,7 @@ git submodule update --init
 Then you create a link here:
 
 ```sh
-ln -s ../vendor/kokkos kokkos
+ln -s ../../../vendor/kokkos kokkos
 ```
 
 ## Step 2: Build Kokkos with default parameters
@@ -51,7 +51,7 @@ This way, you can easily clean up the build directory without affecting the sour
 To create a build directory and build Kokkos with default parameters, you can use the following commands:
 
 ```bash
-cmake -B build_serial -DCMAKE_INSTALL_PREFIX=${PWD}/install_default kokkos
+cmake -B build_serial -DCMAKE_INSTALL_PREFIX=${PWD}/install_serial kokkos
 cmake --build build_serial
 cmake --install build_serial
 ```

exercises/01_first_program/exercise/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required (VERSION 3.21)
 
 project(01FirstProgramExercise LANGUAGES CXX)
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/modules")
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../../cmake/modules")
 
 find_package(Kokkos REQUIRED)
 

exercises/01_first_program/solution/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required (VERSION 3.21)
 
 project(01FirstProgramSolution LANGUAGES CXX)
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/modules")
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../../cmake/modules")
 
 find_package(Kokkos REQUIRED)
 

exercises/02_basic_view/exercise/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required (VERSION 3.21)
 
 project(02BasicViewExercise LANGUAGES CXX)
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/modules")
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../../cmake/modules")
 
 find_package(Kokkos REQUIRED)