Merge pull request #931 from PrincetonUniversity/devel

Release v0.4.0 candidate

Author: Rohit-Kakodkar

.github/pull_request_template.md

@@ -11,6 +11,8 @@ If there is an issue created for these changes, link it here
 Please make sure to check developer documentation on specfem docs.
 
 - [ ] I ran the code through pre-commit to check style
+- [ ] **THE DOCUMENTATION BUILDS WITHOUT WARNINGS/ERRORS**
+- [ ] I have added labels to the PR (see right hand side of the PR page)
 - [ ] My code passes all the integration tests
 - [ ] I have added sufficient unittests to test my changes
 - [ ] I have added/updated documentation for the changes I am proposing

.github/release.yaml

@@ -0,0 +1,51 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - dependencies
+      - dependency
+  categories:
+    - title: 🚨 Breaking Changes
+      labels:
+        - breaking-change
+    - title: 🎉 New Feature
+      labels:
+        - feature
+    - title: 👨‍🔬 New physics 
+      labels:
+        - new physics
+    - title: 🚀 Performance enhancement
+      labels:
+        - performance enhancement
+    - title: ✚ Enhancement
+      labels:
+        - enhancement
+    - title: 📚 Documentation
+      labels:
+        - documentation
+        - docs
+    - title: Code Style Updates
+      labels:
+        - style
+    - title: Fortran Meshfem2D/3D updates
+      labels:
+        - fortran
+    - title: Refactor 
+      labels:
+        - refactor
+    - title: 🐛 Bug Fixes
+      labels:
+        - bug
+        - fix
+    - title: Configuration/CMake
+      labels:
+        - configuration
+    - title: 🔧 Maintenance
+      labels:
+        - maintenance
+    - title: 🧾 New tests
+      labels:
+        - tests
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/compilation.yml

@@ -1,6 +1,13 @@
 name: Build
 
-on: [push]
+on:
+  push:
+    branches:
+      - main
+      - devel
+  pull_request:
+    branches:
+      - '*' # All branches
 
 jobs:
   build-serial:
@@ -10,9 +17,6 @@ jobs:
         run: gcc --version && cmake --version
       - name: Checkout repository
         uses: actions/checkout@v1
-      - name: Get submodules
-        run: git submodule init
-          &&  git submodule update
       - name: Configure Serial build
         run: cmake -S . -B build
       - name: Build

.github/workflows/unittests.yml

@@ -1,6 +1,14 @@
 name: Unittests
 
-on: [push]
+on:
+  push:
+    branches:
+      - main
+      - devel
+  pull_request:
+    branches:
+      - '*' # All branches should run on PRs
+
 
 jobs:
   build-and-test:
@@ -10,9 +18,6 @@ jobs:
         run: gcc --version && cmake --version
       - name: Checkout repository
         uses: actions/checkout@v1
-      - name: Get submodules
-        run: git submodule init
-          &&  git submodule update
       - name: Configure
         run: cmake -S . -B build -D CMAKE_BUILD_TYPE=Release -D BUILD_TESTS=ON
       - name: Build

.gitignore

@@ -1,3 +1,4 @@
+CMakeUserPresets.json
 .vscode/
 .DS_Store
 build*/*
@@ -15,6 +16,7 @@ examples/*/*_config.yaml
 tests/regression-tests/*.yaml
 tests/regression-tests/*/cpu/*.yaml
 tests/regression-tests/*/gpu/*.yaml
+tests/unit-tests/error_jacobian/small_jacobian.png
 *.mod
 *.o
 */OUTPUT_FILES/*
@@ -28,3 +30,8 @@ examples/*/Par_File
 autotuning/
 profiles
 .cache/
+test*.cpp
+test*.hpp
+include/specfem_setup.hpp
+install
+bin

.gitmodules

@@ -5,19 +5,12 @@ pipeline{
         }
     }
     stages{
-        stage( ' Load git modules ' ){
-            steps {
-                echo ' Getting git submodules '
-                sh 'git submodule init'
-                sh 'git submodule update'
-            }
-        }
         stage(' GNU Host Compiler Check '){
             matrix {
                 axes {
                     axis{
                         name 'GNUCompiler'
-                        values 'GCC8;gcc/8', 'GCC13;gcc-toolset/13'
+                        values 'GCC8;gcc/11', 'GCC13;gcc-toolset/14'
                     }
                     axis{
                         name 'SIMD'
@@ -68,7 +61,7 @@ pipeline{
                                     sh """
                                         module load boost/1.85.0
                                         module load ${GNU_COMPILER_MODULE}
-                                        cmake3 -S . -B build_cpu_${GNU_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG} -DCMAKE_BUILD_TYPE=Release ${CMAKE_HOST_FLAGS} ${SIMD_FLAGS} -DBUILD_TESTS=ON -D BUILD_EXAMPLES=OFF
+                                        cmake3 -S . -B build_cpu_${GNU_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG} -DCMAKE_BUILD_TYPE=Release ${CMAKE_HOST_FLAGS} ${SIMD_FLAGS} -DBUILD_TESTS=ON -D BUILD_BENCHMARKS=OFF
                                         cmake3 --build build_cpu_${GNU_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG}
                                     """
                                     echo ' Build completed '
@@ -81,7 +74,8 @@ pipeline{
                                         module load boost/1.85.0
                                         module load ${GNU_COMPILER_MODULE}
                                         cd build_cpu_${GNU_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG}/tests/unit-tests
-                                        srun -N 1 -t 00:20:00 ${HOST_RUN_FLAGS} --constraint=skylake bash -c 'export OMP_PROC_BIND=spread; export OMP_THREADS=places; ctest --verbose;'
+                                        export BUILD_DIR=build_cpu_${GNU_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG}
+                                        srun -N 1 -t 00:20:00 ${HOST_RUN_FLAGS} --constraint="intel|cascade" bash -c 'export OMP_PROC_BIND=spread; export OMP_THREADS=places; ctest --verbose;'
                                     """
                                     echo ' Testing completed '
                                 }

.jenkins/gnu_compiler_checks.gvy

@@ -5,19 +5,12 @@ pipeline{
         }
     }
     stages{
-        stage( ' Load git modules ' ){
-            steps {
-                echo ' Getting git submodules '
-                sh 'git submodule init'
-                sh 'git submodule update'
-            }
-        }
         stage(' Intel Host Compiler Check '){
             matrix {
                 axes {
                     axis{
                         name 'IntelCompiler'
-                        values 'ICC2022;intel/2022.2.0', 'ICC2024;intel/2024.0.2'
+                        values 'ICC2024;intel/2024.2'
                     }
                     axis{
                         name 'HostSpace'
@@ -69,7 +62,7 @@ pipeline{
                                         module load ${INTEL_MODULE}
                                         export CC=icx
                                         export CXX=icpx
-                                        cmake3 -S . -B build_cpu_${INTEL_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG} -DCMAKE_BUILD_TYPE=Release ${CMAKE_HOST_FLAGS} ${SIMD_FLAGS} -D BUILD_TESTS=ON -D BUILD_EXAMPLES=OFF
+                                        cmake3 -S . -B build_cpu_${INTEL_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG} -DCMAKE_BUILD_TYPE=Release ${CMAKE_HOST_FLAGS} ${SIMD_FLAGS} -D BUILD_TESTS=ON -D BUILD_BENCHMARKS=OFF
                                         cmake3 --build build_cpu_${INTEL_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG}
                                     """
                                     echo ' Build completed '
@@ -82,7 +75,8 @@ pipeline{
                                         module load boost/1.85.0
                                         module load ${INTEL_MODULE}
                                         cd build_cpu_${INTEL_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG}/tests/unit-tests
-                                        srun -N 1 -t 00:20:00 ${HOST_RUN_FLAGS} --constraint=skylake bash -c 'export OMP_PROC_BIND=spread; export OMP_THREADS=places; ctest --verbose;'
+                                        export BUILD_DIR=build_cpu_${INTEL_COMPILER_NAME}_${CMAKE_HOST_NAME}_${SIMD_NAME}_${env.BUILD_TAG}
+                                        srun -N 1 -t 00:20:00 ${HOST_RUN_FLAGS} --constraint="intel|cascade" bash -c 'export OMP_PROC_BIND=spread; export OMP_THREADS=places; ctest --verbose;'
                                     """
                                     echo ' Testing completed '
                                 }

.jenkins/intel_compiler_checks.gvy

@@ -5,19 +5,12 @@ pipeline{
         }
     }
     stages{
-        stage( ' Load git modules ' ){
-            steps {
-                echo ' Getting git submodules '
-                sh 'git submodule init'
-                sh 'git submodule update'
-            }
-        }
         stage(' NVIDIA Device Compiler Check '){
             matrix {
                 axes {
                     axis{
                         name 'CUDACompiler'
-                        values 'CUDA117;cudatoolkit/11.7', 'CUDA126;cudatoolkit/12.6'
+                        values 'CUDA117;cudatoolkit/11.8', 'CUDA126;cudatoolkit/12.8'
                     }
                     axis{
                         name 'HostSpace'
@@ -83,7 +76,7 @@ pipeline{
                                     sh """
                                         module load boost/1.85.0
                                         module load ${CUDA_MODULE}
-                                        cmake3 -S . -B build_cuda_${CUDA_COMPILER_NAME}_${CMAKE_HOST_NAME}_${CMAKE_DEVICE_NAME}_${SIMD_NAME}_${env.BUILD_TAG} -DCMAKE_BUILD_TYPE=Release ${CMAKE_HOST_FLAGS} ${CMAKE_DEVICE_FLAGS} ${SIMD_FLAGS} -D BUILD_TESTS=ON -D BUILD_EXAMPLES=OFF
+                                        cmake3 -S . -B build_cuda_${CUDA_COMPILER_NAME}_${CMAKE_HOST_NAME}_${CMAKE_DEVICE_NAME}_${SIMD_NAME}_${env.BUILD_TAG} -DCMAKE_BUILD_TYPE=Release ${CMAKE_HOST_FLAGS} ${CMAKE_DEVICE_FLAGS} ${SIMD_FLAGS} -D BUILD_TESTS=ON -D BUILD_BENCHMARKS=OFF
                                         cmake3 --build build_cuda_${CUDA_COMPILER_NAME}_${CMAKE_HOST_NAME}_${CMAKE_DEVICE_NAME}_${SIMD_NAME}_${env.BUILD_TAG}
                                     """
                                     echo ' Build completed '
@@ -96,7 +89,8 @@ pipeline{
                                         module load boost/1.85.0
                                         module load ${CUDA_MODULE}
                                         cd build_cuda_${CUDA_COMPILER_NAME}_${CMAKE_HOST_NAME}_${CMAKE_DEVICE_NAME}_${SIMD_NAME}_${env.BUILD_TAG}/tests/unit-tests
-                                        srun -N 1 -t 00:20:00 ${HOST_RUN_FLAGS} ${DEVICE_RUN_FLAGS} bash -c 'export OMP_PROC_BIND=spread; export OMP_THREADS=places; ctest --verbose;'
+                                        export BUILD_DIR=build_cuda_${CUDA_COMPILER_NAME}_${CMAKE_HOST_NAME}_${CMAKE_DEVICE_NAME}_${SIMD_NAME}_${env.BUILD_TAG}
+                                        srun -N 1 -t 00:30:00 ${HOST_RUN_FLAGS} ${DEVICE_RUN_FLAGS} bash -c 'export OMP_PROC_BIND=spread; export OMP_THREADS=places; ctest --verbose;'
                                     """
                                     echo ' Testing completed '
                                 }

.jenkins/nvidia_compiler_checks.gvy

@@ -6,13 +6,6 @@ pipeline {
     }
 
     stages {
-        stage( ' Load git modules ' ){
-            steps {
-                echo ' Getting git submodules '
-                sh 'git submodule init'
-                sh 'git submodule update'
-            }
-        }
         stage (' GNU Unittests '){
             matrix {
                 axes {