Merge pull request #284 from LLNL/v0.7-dev

v0.7 Release Prep

Author: steiltre

.github/workflows/ci-test.yaml

@@ -2,7 +2,7 @@ name: CI Test
 
 on:
   pull_request:
-    branches: [ master, develop ]
+    branches: [ master, '**-dev' ]
   push:
     branches: [ 'feature/**', 'hotfix/**']
 
@@ -14,17 +14,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, ubuntu-20.04]
-        gcc-version: [8, 9, 10]
+        os: [ubuntu-24.04, ubuntu-22.04]
+        gcc-version: [11, 12, 13, 14]
         mpi-type: [mpich, openmpi]
         exclude:
-          - os: ubuntu-latest
-            gcc-version: 8
+          - os: ubuntu-22.04
+            gcc-version: 13
+          - os: ubuntu-22.04
+            gcc-version: 14
+          - os: ubuntu-24.04
+            mpi-type: mpich
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+      - name: Update apt
+        run: |
+          sudo add-apt-repository -y universe
+          sudo apt-get update
       - name: Cache boost
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-boost
         with:
           path: "~/boost_1_77_0"
@@ -33,32 +41,35 @@ jobs:
         if: steps.cache-boost.outputs.cache-hit != 'true'
         run: |
           cd ~
-          wget --no-verbose https://boostorg.jfrog.io/artifactory/main/release/1.77.0/source/boost_1_77_0.tar.bz2
+          wget --no-verbose https://archives.boost.io/release/1.77.0/source/boost_1_77_0.tar.bz2
           tar -xjf boost_1_77_0.tar.bz2
       - name: Install Apache Arrow
+        if: ${{ matrix.os == 'ubuntu-latest'}} # Skip on ubuntu-20.04 due to pyarrow's ABI incompatibility issue
         run: |
-          cd ~
-          wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
-          sudo apt-get install ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
-          sudo apt-get update
-          sudo apt-get install libarrow-dev libparquet-dev
+          python -m pip install pyarrow==16.1.*
+          PIP_PYARROW_ROOT=$(python -c "import pyarrow as pa; print(pa.get_library_dirs()[0])")
+          echo "PIP_PYARROW_ROOT=${PIP_PYARROW_ROOT}" >> $GITHUB_ENV
+          echo "ENABLE_PARQUET_TEST=true" >> $GITHUB_ENV
       - name: Install mpich
         if: matrix.mpi-type == 'mpich'
         run: sudo apt-get install mpich
       - name: Install OpenMPI
         if: matrix.mpi-type == 'openmpi'
         run: sudo apt-get install openmpi-bin libopenmpi-dev
       - name: Install GCC-${{ matrix.gcc-version }}
-        if: matrix.gcc-version == '8'
-        run: sudo apt-get install gcc-8 g++-8
+        if: (matrix.gcc-version == '11' && matrix.os == 'ubuntu-24.04')
+        run: sudo apt-get install gcc-11 g++-11
       - name: Make
         run: |
           echo Run 'make'
           mpicc -show
           g++-${{ matrix.gcc-version }} --version
           mkdir build
           cd build
-          cmake ../ -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DCMAKE_CXX_COMPILER=g++-${{ matrix.gcc-version }} -DBOOST_ROOT=~/boost_1_77_0 -DYGM_REQUIRE_ARROW=ON
+          if [ "$ENABLE_PARQUET_TEST" ]; then
+            ARROW_CMAKE_OPTION="-DPIP_PYARROW_ROOT=$PIP_PYARROW_ROOT -DYGM_REQUIRE_PARQUET=ON"
+          fi
+          cmake ../ -DYGM_BUILD_TESTS=On -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DCMAKE_CXX_COMPILER=g++-${{ matrix.gcc-version }} -DBOOST_ROOT=~/boost_1_77_0 ${ARROW_CMAKE_OPTION}
           make -j
       - name: Make test (mpich)
         if: matrix.mpi-type == 'mpich'

.gitignore

@@ -1,4 +1,6 @@
 *~
 *#*
 build*
-.vscode*
+.vscode*
+.idea*
+.cache/

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+# Set OS and Python versions
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+# Change the location of the requirements file
+python:
+  install:
+    - requirements: docs/rtd/requirements.txt
+
+# Change the location of the configuration file
+sphinx:
+  configuration: docs/rtd/conf.py

CMakeLists.txt

@@ -7,38 +7,29 @@ cmake_minimum_required(VERSION 3.14)
 
 project(
     ygm
-    VERSION 0.6
+    VERSION 0.7
     DESCRIPTION "HPC Communication Library"
     LANGUAGES CXX
 )
 
-if (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
-    set(YGM_MAIN_PROJECT ON)
-endif ()
-
-# Controls whether to set up install boilerplate for project and depencencies.
-# Expects CMAKE_INSTALL_PREFIX to be set to a suitable directory.
-option(YGM_INSTALL "Generate the install target" ${YGM_MAIN_PROJECT})
-
-# Only do these if this is the main project, and not if it is included through
-# add_subdirectory
-if (YGM_MAIN_PROJECT)
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
-    # Let's nicely support folders in IDE's
-    set_property(GLOBAL PROPERTY USE_FOLDERS ON)
-
-    # Testing only available if this is the main app Note this needs to be done
-    # in the main CMakeLists since it calls enable_testing, which must be in the
-    # main CMakeLists.
-    include(CTest)
+#
+# Configuration options for YGM
+#
+option(JUST_INSTALL_YGM_HEADERS "Install YGM header files without building anything" OFF)
+option(YGM_BUILD_TESTS "Build tests" OFF)
+option(YGM_BUILD_TOOLS "Build tools" OFF)
+option(YGM_DOXYGEN "Adds targets for generating Doxygen documentation" OFF)
+option(YGM_RTD_ONLY "Run Cmake for only generating documentation for Read the Docs" OFF)
+option(YGM_REQUIRE_PARQUET "YGM requires Arrow Parquet." OFF)
+option(YGM_INSTALL_PARQUET "YGM installs Arrow Parquet if it is not found." OFF)
 
-    # Docs only available if this is the main app
-    find_package(Doxygen)
-    if (Doxygen_FOUND)
-        # add_subdirectory(docs)
-    else ()
-        message(STATUS "Doxygen not found, not building docs")
-    endif ()
+#
+# Early exit if only installing headers
+#
+if (JUST_INSTALL_YGM_HEADERS)
+  return()
 endif ()
 
 # Require out-of-source builds
@@ -73,7 +64,7 @@ if (NOT cereal_FOUND)
     FetchContent_Declare(
         cereal
         GIT_REPOSITORY https://github.com/USCiLab/cereal.git
-        GIT_TAG af0700efb25e7dc7af637b9e6f970dbb94813bff
+        GIT_TAG v1.3.2
     )
     FetchContent_GetProperties(cereal)
     if (cereal_POPULATED)
@@ -85,7 +76,7 @@ if (NOT cereal_FOUND)
         # Do not compile any cereal tests
         set(JUST_INSTALL_CEREAL ON)
         # Install cereal at ${CMAKE_INSTALL_PREFIX}
-        set(CEREAL_INSTALL ${YGM_INSTALL})
+        set(CEREAL_INSTALL ON)
         # Populate cereal
         FetchContent_Populate(cereal)
         # Include cereal root cmake boilerplate
@@ -134,125 +125,73 @@ endif ()
 # Arrow
 #
 #
-find_package(Arrow 8.0 QUIET)
-if (NOT Arrow_FOUND)
-	find_package(Arrow 9.0 QUIET)
-endif()
-if (NOT Arrow_FOUND)
-	find_package(Arrow 10.0 QUIET)
-endif()
-if (NOT Arrow_FOUND)
-	find_package(Arrow 11.0 QUIET)
-endif()
-if (NOT Arrow_FOUND)
-	find_package(Arrow 12.0 QUIET)
-endif()
-if (NOT Arrow_FOUND)
-	find_package(Arrow 13.0 QUIET)
-endif()
-if (NOT Arrow_FOUND)
-	find_package(Arrow 14.0 QUIET)
-endif()
-if (NOT Arrow_FOUND)
-	find_package(Arrow 15.0 QUIET)
-endif()
-if (Arrow_FOUND)
-   message(STATUS ${PROJECT_NAME} " found Arrow ")
-   message(STATUS "Arrow version: ${ARROW_VERSION}")
-   message(STATUS "Arrow SO version: ${ARROW_FULL_SO_VERSION}")
-   set(ARROW_CMAKE_DIR ${Arrow_DIR})
-   find_package(Parquet PATHS ${ARROW_CMAKE_DIR})
-   if (Parquet_FOUND)
-       message(STATUS ${PROJECT_NAME} " found Parquet ")
-       message(STATUS "Parquet version: ${PARQUET_VERSION}")
-       message(STATUS "Parquet SO version: ${PARQUET_FULL_SO_VERSION}")
-   else ()
-       message(WARNING ${PROJECT_NAME} " did not find Parquet. Building without Parquet.")
-   endif ()
-else ()
-   message(WARNING ${PROJECT_NAME} " did not find Arrow >= 8.0. Building without Arrow.")
-   if (YGM_REQUIRE_ARROW)
-	   message(FATAL_ERROR "YGM configured to require Arrow, but Arrow could not be found")
-   endif ()
-endif ()
+include(FindArrowParquet)
+find_or_install_arrow_parquet()
 
 #
 # Create the YGM target library
 #
 add_library(ygm INTERFACE)
 add_library(ygm::ygm ALIAS ygm)
-target_compile_features(ygm INTERFACE cxx_std_17)
+target_compile_features(ygm INTERFACE cxx_std_20)
 target_include_directories(
     ygm INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
                   $<INSTALL_INTERFACE:include>
 )
 target_link_libraries(
-    ygm INTERFACE MPI::MPI_CXX Threads::Threads stdc++fs ${YGM_CEREAL_TARGET}
+    ygm INTERFACE MPI::MPI_CXX Threads::Threads stdc++fs rt ${YGM_CEREAL_TARGET}
 )
 
 option(TEST_WITH_SLURM "Run tests with Slurm" OFF)
 
 # Install ygm. Expects CMAKE_INSTALL_PREFIX to be set to a suitable directory.
-if (${YGM_INSTALL})
-    include(GNUInstallDirs)
-    include(CMakePackageConfigHelpers)
-
-    # List libraries to be installed
-    set(YGM_EXPORT_TARGETS ygm)
-
-    install(
-        TARGETS ${PROJECT_NAME}
-        EXPORT ${PROJECT_NAME}Targets
-        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    )
-
-    install(
-        EXPORT ${PROJECT_NAME}Targets
-        FILE ${PROJECT_NAME}Targets.cmake
-        NAMESPACE ${PROJECT_NAME}::
-        DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake
-    )
-
-    install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/ygm
-            DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-    )
-
-    # create version file
-    write_basic_package_version_file(
-        "${PROJECT_NAME}ConfigVersion.cmake"
-        VERSION ${PROJECT_VERSION}
-        COMPATIBILITY ExactVersion
-    )
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
+
+# List libraries to be installed
+set(YGM_EXPORT_TARGETS ygm)
+
+install(
+    TARGETS ${PROJECT_NAME}
+    EXPORT ${PROJECT_NAME}Targets
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+)
 
-    # create config file
-    configure_package_config_file(
-        "${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in"
-        "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-        INSTALL_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake
-    )
+install(
+    EXPORT ${PROJECT_NAME}Targets
+    FILE ${PROJECT_NAME}Targets.cmake
+    NAMESPACE ${PROJECT_NAME}::
+    DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake
+)
 
-    install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-                  "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
-            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake
-    )
+install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/ygm
+        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
 
-endif ()
+# create version file
+write_basic_package_version_file(
+    "${PROJECT_NAME}ConfigVersion.cmake"
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY ExactVersion
+)
 
-option(JUST_INSTALL_YGM "Skip executable compilation" OFF)
-if (JUST_INSTALL_YGM)
-    return()
-endif ()
+# create config file
+configure_package_config_file(
+    "${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in"
+    "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+    INSTALL_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake
+)
 
-if (NOT CMAKE_BUILD_TYPE)
-	set(CMAKE_BUILD_TYPE Release)
-	message(STATUS "CMAKE_BUILD_TYPE is set as Release")
-endif ()
+install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+              "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+        DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake
+)
 
-# Testing & examples are only available if this is the main app
-if (YGM_MAIN_PROJECT)
+if (YGM_BUILD_TESTS)
     add_subdirectory(test)
-    # Example codes are here.
-    add_subdirectory(examples)
+endif ()
+if (YGM_BUILD_TOOLS)
+    add_subdirectory(tools)
 endif ()