Cross platform command line driver + PropLib template adherence

.github/workflows/ctest.yml

@@ -1,5 +1,4 @@
-# This action compiles the library and runs all unit tests using an OS and CMake matrix
-# Doxygen documentation is also built. Build fails on missing documentation.
+# This action compiles the library and driver and runs all unit tests using an OS and CMake matrix
 name: Unit Tests
 
 on:
@@ -16,8 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # Windows-2019 is used as a dedicated 32-bit build/test platform
-        os: [ubuntu-latest, macos-latest, windows-latest, windows-2019]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         # CMake >= 3.21 is required to use "--preset <presetName>" and discover generators
         cmakeVersion: ["3.21", latest]
 
@@ -28,31 +26,17 @@ jobs:
     - name: Clone required submodules
       run: |
         git submodule init extern/googletest
-        git submodule init extern/doxygen-awesome-css
         git submodule update
 
     - name: Install CMake
       uses: lukka/get-cmake@latest
       with:
         cmakeVersion: ${{ matrix.cmakeVersion }}
-
-    - name: Install Doxygen
-      uses: ssciwr/doxygen-install@v1
-      with:
-        version: "1.11.0"
-
-    - name: "CMake: Build and Test (32-bit)"
-      if: matrix.os == 'windows-2019'
-      uses: lukka/run-cmake@v10
-      with:
-        configurePreset: release32
-        buildPreset: release32
-        testPreset: release32
 
-    - name: "CMake: Build and Test (64-bit)"
-      if: matrix.os != 'windows-2019'
+    - name: "CMake: Build and Test"
       uses: lukka/run-cmake@v10
       with:
-        configurePreset: release64
-        buildPreset: release64
-        testPreset: release64
+        configurePreset: release
+        configurePresetAdditionalArgs: "['-DBUILD_DOCS=OFF']"
+        buildPreset: release
+        testPreset: release

.github/workflows/doxygen.yml

@@ -8,6 +8,8 @@ on:
     types: ["published"]
   pull_request:
     branches: ["main", "dev"]
+  push:
+    branches: ["main", "dev"]
   workflow_dispatch:
 
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
@@ -31,7 +33,7 @@ jobs:
         - name: Install Doxygen
           uses: ssciwr/doxygen-install@v1
           with:
-            version: "1.11.0"
+            version: "1.12.0"
 
         - name: Setup GitHub Pages
           if: ${{ github.event_name == 'release' }}
@@ -54,7 +56,7 @@ jobs:
             path: ./docs/html/
 
   deploy:
-    if: ${{ github.event_name == 'release'}}
+    if: ${{ github.event_name == 'release' }}
     needs: build
     permissions:
       contents: read
@@ -65,6 +67,6 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-        - name: Deploy to GitHub Pages
-          id: deployment
-          uses: actions/deploy-pages@v4
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -5,7 +5,6 @@ name: Create Release Artifacts
 on:
   push:
     tags: ['v[0-9]+.*']
-  workflow_dispatch:
 
 permissions:
   contents: write
@@ -16,29 +15,20 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-2019, windows-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Install CMake # (latest stable version)
         uses: lukka/get-cmake@latest
 
-      - name: "CMake: Build (32-bit)"
-        if: matrix.os == 'windows-2019'
+      - name: "CMake: Build"
         uses: lukka/run-cmake@v10
         with:
-          configurePreset: release32
-          configurePresetAdditionalArgs: "['-DBUILD_DOCS=OFF', '-DRUN_TESTS=OFF']"
-          buildPreset: release32
-
-      - name: "CMake: Build (64-bit)"
-        if: matrix.os != 'windows-2019'
-        uses: lukka/run-cmake@v10
-        with:
-          configurePreset: release64
-          configurePresetAdditionalArgs: "['-DBUILD_DOCS=OFF', '-DRUN_TESTS=OFF']"
-          buildPreset: release64
+          configurePreset: release
+          configurePresetAdditionalArgs: "['-DBUILD_DOCS=OFF', '-DRUN_TESTS=OFF', '-DRUN_DRIVER_TESTS=OFF']"
+          buildPreset: release
 
       - name: Upload release artifact (macOS or Linux)
         if: runner.os != 'Windows'
@@ -48,23 +38,18 @@ jobs:
           path: |
             ${{ github.workspace }}/bin/*.dylib
             ${{ github.workspace }}/bin/*.so
-          if-no-files-found: error
-          overwrite: true
-
-      - name: Upload release artifact (Windows x86)
-        if: matrix.os == 'windows-2019'
-        uses: actions/upload-artifact@v4
-        with:
-          name: release-windows-x86
-          path: ${{ github.workspace }}\bin\Debug\*.dll
+            ${{ github.workspace }}/bin/*Driver-Darwin-*
+            ${{ github.workspace }}/bin/*Driver-Linux-*
           if-no-files-found: error
           overwrite: true
 
-      - name: Upload release artifact (Windows x64)
-        if: matrix.os == 'windows-latest'
+      - name: Upload release artifact (Windows)
+        if: runner.os == 'Windows'
         uses: actions/upload-artifact@v4
         with:
-          name: release-windows-x64
-          path: ${{ github.workspace }}\bin\Debug\*.dll
+          name: release-${{ matrix.os }}
+          path: |
+            ${{ github.workspace }}\bin\Release\*.dll
+            ${{ github.workspace }}\bin\Release\*Driver-Windows-*.exe
           if-no-files-found: error
           overwrite: true

.gitignore

@@ -6,6 +6,21 @@
 Thumbs.db
 *.o
 
+####################################
+## Shared Library files in Wrappers
+####################################
+**.dll
+**.so
+**.dylib
+
+######################################
+## Derived files produced by wrappers
+######################################
+**.mltbx
+**.whl
+**.tar.gz
+**.nupkg
+
 #################
 ## Visual Studio
 #################

.gitmodules

@@ -1,7 +1,7 @@
-[submodule "extern/doxygen-awesome-css"]
-	path = extern/doxygen-awesome-css
-	url = https://github.com/jothepro/doxygen-awesome-css
 [submodule "extern/googletest"]
 	path = extern/googletest
 	url = https://github.com/google/googletest
 	branch = v1.12.x
+[submodule "extern/doxygen-awesome-css"]
+	path = extern/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css

.zenodo.json

@@ -11,9 +11,10 @@
             "name": "Romaniello, Anthony W."
         }
     ],
-    "title": "Recommendation ITU-R P.2108-1, Release 1.0",
+    "license": "NTIA Public Domain",
+    "title": "Recommendation ITU-R P.2108-1",
     "description": "Models for the prediction of clutter loss",
     "upload_type": "software",
-    "version": "1.0.0",
+    "version": "1.0",
     "keywords": ["Study Group 3", "ITU-R", "P2108", "clutter", "propagation"]
-}
+}

CITATION.cff

@@ -34,7 +34,7 @@ authors:
     email: [email protected]
     website: 'https://its.ntia.gov'
 repository-code: 'https://github.com/NTIA/p2108'
-url: 'https://github.com/NTIA/propagation/wiki'
+url: 'https://ntia.github.io/propagation-library-wiki/models/P2108'
 repository: 'https://github.com/NTIA/p2108'
 keywords:
   - propagation

CMakeLists.txt

@@ -12,7 +12,7 @@ set(LIB_NAME "P2108")                 # Name of library/target
 set(LIB_NAMESPACE "ITS.ITU.PSeries")  # Namespace for the named library
 project(
     "${LIB_NAMESPACE}.${LIB_NAME}"
-    VERSION 1.0.0
+    VERSION 1.0
     DESCRIPTION "Recommendation ITU-R P.2108, U.S. Reference Implementation"
     HOMEPAGE_URL "https://ntia.github.io/propagation-library-wiki/models/P2108"
     LANGUAGES "CXX"
@@ -28,12 +28,13 @@ set(PYTHON_WRAPPER_DIR "${PROJECT_SOURCE_DIR}/wrap/python")
 ###########################################
 ## CMAKE OPTIONS AND DEFAULTS
 ###########################################
-# Define options. Defaults to: compile 64-bit library, build docs, run tests
-option(BUILD_DOCS "Generate documentation with Doxygen" ON)
-option(DOCS_ONLY "Skip all steps except generating documentation" OFF)
-option(RUN_TESTS "Run C++ unit tests with Google Test + CTest" ON)
-option(COPY_TO_WRAPPERS "Copy compiled library into wrapper submodules" ON)
-option(BUILD_32BIT "Build project for x86/32-bit instead of x64/64-bit" OFF)
+# Define options. Defaults to: compile 64-bit library and driver, build docs, run tests
+option(BUILD_DOCS "Generate documentation site with Doxygen" ON)
+option(BUILD_DRIVER "Build the command-line driver executable" ON)
+option(RUN_DRIVER_TESTS "Test the command-line driver executable" ON)
+option(DOCS_ONLY "Skip all steps except generating the documentation site" OFF)
+option(RUN_TESTS "Run unit tests for the main library" ON)
+option(COPY_TO_WRAPPERS "Copy the compiled shared library into wrapper submodules" ON)
 
 ###########################################
 ## SETUP
@@ -50,17 +51,25 @@ if (NOT DOCS_ONLY)
     if (COPY_TO_WRAPPERS)  # Copy compiled library to wrappers
         add_subdirectory(wrap)
     endif ()
-    if (RUN_TESTS)         # Build and run unit tests
+    if (RUN_TESTS OR RUN_DRIVER_TESTS)
         if (EXISTS "${PROJECT_SOURCE_DIR}/extern/googletest/CMakeLists.txt")
             enable_testing()
-            add_subdirectory(tests)
+            set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+            add_subdirectory("${PROJECT_SOURCE_DIR}/extern/googletest" "extern/googletest")
+            include(GoogleTest)
         else ()
             message(SEND_ERROR
                 "Unable to build tests. GoogleTest submodule is missing. "
                 "Run `git submodule init extern/googletest` then "
                 "`git submodule update` and try again."
             )
-        endif()
+        endif ()
+    endif ()
+    if (RUN_TESTS)         # Build and run unit tests
+        add_subdirectory(tests)
+    endif ()
+    if (BUILD_DRIVER OR RUN_DRIVER_TESTS)
+        add_subdirectory(app)
     endif ()
 endif ()