containerized-ci.yml

name: Continuous integration in a box
on:
  push:
    branches:
    - main
    - develop
  pull_request:
    branches-ignore:
    - documentation
  workflow_dispatch:

jobs:
  Containerized-CI:
    runs-on: ubuntu-22.04
    strategy:
      fail-fast: false
      matrix:
        fortran-compiler: [ifort, ifx, nvfortran]
        rte-kernels: [default, accel]
        fpmodel: [DP, SP]
        include:
        # Set flags for Intel Fortran Compiler Classic
        - fortran-compiler: ifort
          fcflags: -m64 -g -traceback -heap-arrays -assume realloc_lhs -extend-source 132 -check bounds,uninit,pointers,stack -stand f08 -diag-disable=10448
        # Set flags for Intel Fortran Compiler
        - fortran-compiler: ifx
          rte-kernels: default
          fcflags: -debug -traceback -O0 -heap-arrays -assume realloc_lhs -extend-source 132 -stand f08
        - fortran-compiler: ifx
          rte-kernels: accel
          fcflags: -debug -traceback -O0 -heap-arrays -assume realloc_lhs -extend-source 132 -stand f08 -fiopenmp -fopenmp-targets=spir64
        # Set flags for NVIDIA Fortran compiler
        - fortran-compiler: nvfortran
          rte-kernels: default
          fcflags: -Mallocatable=03 -Mstandard -Mbounds -Mchkptr -Kieee -Mchkstk
        - fortran-compiler: nvfortran
          rte-kernels: accel
          fcflags: -Mallocatable=03 -Mstandard -Mbounds -Mchkptr -Kieee -Mchkstk -acc
        # Set container images
        - fortran-compiler: ifort
          image: ghcr.io/earth-system-radiation/rte-rrtmgp-ci:oneapi
        - fortran-compiler: ifx
          image: ghcr.io/earth-system-radiation/rte-rrtmgp-ci:oneapi
        - fortran-compiler: nvfortran
          image: ghcr.io/earth-system-radiation/rte-rrtmgp-ci:nvhpc
    container:
      image: ${{ matrix.image }}
    env:
      # Core variables:
      FC: ${{ matrix.fortran-compiler }}
      FCFLAGS: ${{ matrix.fcflags }}
      # CMake variables:
      NFHOME: /opt/netcdf-fortran
      RTE_KERNELS: ${{ matrix.rte-kernels }}
      RRTMGP_DATA_VERSION: v1.8.2
      BUILD_TYPE: Debug
      RUN_CMD:
      # https://github.com/earth-system-radiation/rte-rrtmgp/issues/194
      OMP_TARGET_OFFLOAD: DISABLED
      FAILURE_THRESHOLD: 7.e-4

    steps:
    #
    # Check out repository under $GITHUB_WORKSPACE
    #
    - name: Check out code
      uses: actions/checkout@v4
    #
    # Install required tools
    #
    - name: Install Required Tools
      run: |
        apt-get update
        apt-get install -y git cmake ninja-build
    #
    # Update Failure threshold if single precision
    #
    - name: Failure threshold
      if: matrix.fpmodel == 'SP'
      run: echo "FAILURE_THRESHOLD=3.5e-1" >> $GITHUB_ENV
    #
    # Build libraries, examples and tests (expect success)
    #
    - name: Build libraries, examples and tests (expect success)
      id: build-success
      if: matrix.fortran-compiler != 'ifx' || matrix.rte-kernels != 'accel'
      run: |
          # Run CMake
          cmake -S . -B build -G "Ninja" \
              -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
              -DCMAKE_Fortran_COMPILER=${{ env.FC }} \
              -DCMAKE_Fortran_FLAGS="${{ env.FCFLAGS }}" \
              -DRRTMGP_DATA_VERSION=${{ env.RRTMGP_DATA_VERSION }} \
              -DPRECISION=${{ matrix.fpmodel }} \
              -DKERNEL_MODE=${{ env.RTE_KERNELS }} \
              -DENABLE_TESTS=ON \
              -DFAILURE_THRESHOLD=${{ env.FAILURE_THRESHOLD }}

          # Build the project
          cmake --build build -- -j8
    #
    # Run examples and tests
    #
    - name: Run examples and tests
      working-directory: build
      if: steps.build-success.outcome != 'skipped'
      run: |
        ctest -V
    # Generate validation plots
    #
    - name: Generate validation plots
      if: matrix.fortran-compiler == 'ifort' && matrix.rte-kernels == 'default' && matrix.fpmodel == 'DP'
      run: |
        cmake --build build --target validation-plots
    #
    # Upload validation plots
    #
    - name: Upload validation plots
      if: matrix.fortran-compiler == 'ifort' && matrix.rte-kernels == 'default' && matrix.fpmodel == 'DP'
      uses: actions/upload-artifact@v4
      with:
        name: valdiation-plot
        path: build/tests/validation-figures.pdf