compilation.yml

# -----------------------------------------------------------------------------
# BSD 3-Clause License
#
# Copyright (c) 2020-2026, Science and Technology Facilities Council.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
#   contributors may be used to endorse or promote products derived from
#   this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
# Author A. R. Porter, STFC Daresbury Lab
# Modified by R. W. Ford, STFC Daresbury Lab
# Modified by A. J. Voysey, Met Office
# Modified by J. Henrichs, Bureau of Meteorology
# Modified by N. Nobre, STFC Daresbury Lab

# This workflow will use a self-hosted runner to perform the more expensive
# compilation tests that are not run on GHA systems. At the moment it:
#
#  * Runs the test suite with compilation with gfortran and nvfortran;
#  * Builds the examples with gfortran and nvfortran (the latter with
#    OpenACC enabled).
#  * Builds the tutorials with gfortran and nvfortran.

name: Compilation tests

on:
  push

env:
  CUDA_VERSION: "13"
  GFORTRAN_VERSION: "15"
  HDF5_VERSION: "2.1"
  NETCDF_C_VERSION: "4.10"
  NETCDF_FORTRAN_VERSION: "4.6"
  NVFORTRAN_VERSION: "26.5"
  OPENMPI_VERSION: "5.0"
  PYTHON_VERSION: "3.14"
  NUM_PARALLEL: 16

jobs:
  run_if_on_mirror:
    # Only PSyclone-mirror has the necessary self-hosted runner.
    if: ${{ github.repository == 'stfc/PSyclone-mirror' }}
    runs-on: self-hosted
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: recursive
        # This is required to get the commit history for merge commits for
        # the ci-skip check below.
        fetch-depth: '0'
    - name: Check for [skip ci] in commit message
      uses: mstachniuk/ci-skip@v1
      with:
        # This setting causes the tests to 'fail' if [skip ci] is specified
        fail-fast: true
        commit-filter: '[skip ci]'
    - name: Install dependencies
      run: |
        module load python/${PYTHON_VERSION}
        python -m venv .runner_venv
        . .runner_venv/bin/activate
        python -m pip install --upgrade pip
        # Uncomment the below to use the submodule version of fparser rather
        # than the latest release from pypi.
        # pip install external/fparser
        pip install .[test,psydata,doc,treesitter]
    - name: Unit tests with compilation - gfortran
      run: |
        . .runner_venv/bin/activate
        module load gcc/${GFORTRAN_VERSION} openmpi/${OPENMPI_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        pytest -n ${NUM_PARALLEL} --f90=gfortran --f90flags="-ffree-line-length-none" --compile --compileopencl src/psyclone/tests
    - name: Unit tests with compilation - nvfortran
      run: |
        . .runner_venv/bin/activate
        module load nvidia-hpcsdk/${NVFORTRAN_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        pytest -n ${NUM_PARALLEL} --f90=nvfortran --compile --compileopencl src/psyclone/tests
    - name: Libraries compilation - gfortran
      run: |
        . .runner_venv/bin/activate
        module load gcc/${GFORTRAN_VERSION} openmpi/${OPENMPI_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        make -C lib allclean
        make -C lib all
        # There is an additional test:
        make -C lib/extract test
    - name: Libraries compilation - nvfortran
      run: |
        . .runner_venv/bin/activate
        module load nvidia-hpcsdk/${NVFORTRAN_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        make -C lib allclean
        # We need to overwrite F90FLAGS, since otherwise some gfortran
        # default flags will be used
        F90=nvfortran F90FLAGS="-g" make -C lib all
        # There is an additional test:
        F90=nvfortran make -C lib/extract test
    - name: Examples with compilation - gfortran
      run: |
        . .runner_venv/bin/activate
        make -C examples allclean
        # Although we're using gfortran, we link with CUDA's OpenCL library
        module load gcc/${GFORTRAN_VERSION} openmpi/${OPENMPI_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        module load cuda/${CUDA_VERSION}
        # TODO #3074: Examples compilation cannot be run in parallel
        F90=gfortran make -C examples run
    - name: Tutorials with compilation - gfortran
      run: |
        . .runner_venv/bin/activate
        make -C tutorial/practicals allclean
        module load gcc/${GFORTRAN_VERSION} openmpi/${OPENMPI_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        make -C tutorial/practicals compile
        # Set F90 to mpif90 so the MPI example works, and it also avoids
        # that the openacc example defaults to nvfoetran. Also, the implicitly
        # defined F90FLAGS (in a module?) does not include -fopenmp, which
        # then causes some examples to fail, so explicitly define this
        USE_GPU=no F90=mpif90 F90FLAGS="-g -Wall -O0 -fopenmp" make -C tutorial/training/ test_run
    - name: Examples with compilation - nvfortran
      run: |
        . .runner_venv/bin/activate
        make -C examples allclean
        module load nvidia-hpcsdk/${NVFORTRAN_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        # TODO #3074: Examples compilation cannot be run in parallel
        F90=nvfortran F90FLAGS="-acc -Minfo=all" make -C examples run
    - name: Tutorials with compilation - nvfortran
      run: |
        . .runner_venv/bin/activate
        make -C tutorial/practicals allclean
        make -C tutorial/training allclean
        module load nvidia-hpcsdk/${NVFORTRAN_VERSION}
        module load hdf5/${HDF5_VERSION} netcdf-c/${NETCDF_C_VERSION} netcdf-fortran/${NETCDF_FORTRAN_VERSION}
        F90=nvfortran F90FLAGS="-acc -Minfo=all" make -C tutorial/practicals/LFRic compile
        F90=nvfortran F90FLAGS="-acc -Minfo=all -Mnofma -O2" make -C tutorial/practicals/generic run
        # We cannot run non-GPU examples with the openacc flag, since output_field
        # needs a openacc directive, which fails if the rest of the code is not on GPU
        # Enable OpenMP on CPU (for some run tests)
        USE_GPU=no F90=mpif90 F90FLAGS="-mp -Minfo=all" make -C tutorial/training test_run
        # Delete any previous files, and compile the openacc example with openacc:
        F90=nvfortran F90FLAGS="-acc -Minfo=all" make -C tutorial/training/gocean/2.14-GameOfLife-openacc/solution allclean
        USE_GPU=yes F90=nvfortran F90FLAGS="-acc -Minfo=all" make -C tutorial/training/gocean/2.14-GameOfLife-openacc/solution test_run
        make -C tutorial/practicals/generic/4_openacc acc_test
    - name: Test logfile creation.
      run: |
        . .runner_venv/bin/activate
        cd examples/nemo/eg1
        psyclone -s ./openmp_cpu_levels_trans.py --log-level DEBUG --log-file log.out ../code/tra_adv.F90
        test -f log.out
    - name: Test reasonable psycloning times for complex files
      run: |
        . .runner_venv/bin/activate
        # Fail if it takes more time than expected
        timeout -s INT 12s psyclone /archive/psyclone-tests/latest-run/slow_files/ukca_aero_ctl.F90
        timeout -s INT 0.5s psyclone --frontend treesitter /archive/psyclone-tests/latest-run/slow_files/ukca_aero_ctl.F90