[Feature] CMake Building and Packaging (#114)

* Updating the CMake build for cleaner interpretation

* more updates for cmake in preparation for cpack

* Updating for debian and tgz generator packaging

* removing commented code

* bumping version with build

* Updating CMake to include the debian installation

* Apply suggestions from code review

Co-authored-by: Dimitri Baptiste <55843498+ddbaptiste@users.noreply.github.com>

* Addressing test based PR comments

* Addressing final PR comment

* Hoping this fixes the weird comment?

---------

Co-authored-by: Dimitri Baptiste <55843498+ddbaptiste@users.noreply.github.com>

Author: MJC598

CMakeLists.txt

@@ -1,39 +1,36 @@
 cmake_minimum_required(VERSION 3.27)
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
-
-include(utils)
+set(PRIVATE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
+include(${PRIVATE_MODULE_PATH}/utils.cmake)
 respond_extract_version()
 
 project(respond VERSION ${RESPOND_VERSION} LANGUAGES CXX)
 
 message(STATUS "Build respond: ${RESPOND_VERSION}")
 
-include(GNUInstallDirs)
-
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Set default build to release
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose Release or Debug" FORCE)
 endif()
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Compiler config
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Windows CXX Extensions
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 set(CMAKE_CXX_EXTENSIONS OFF)
 if(CMAKE_SYSTEM_NAME MATCHES "CYGWIN" OR CMAKE_SYSTEM_NAME MATCHES "MSYS" OR CMAKE_SYSTEM_NAME MATCHES "MINGW")
     set(CMAKE_CXX_EXTENSIONS ON)
 endif()
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Set RESPOND_MASTER_PROJECT to ON if we are building respond directly
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 if(NOT DEFINED RESPOND_MASTER_PROJECT)
     if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
         set(RESPOND_MASTER_PROJECT ON)
@@ -42,82 +39,68 @@ if(NOT DEFINED RESPOND_MASTER_PROJECT)
     endif()
 endif()
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Set all default options
-# ---------------------------------------------------------------------------------------
-include(options)
+#-------------------------------------------------------------------------------
+include(${PRIVATE_MODULE_PATH}/options.cmake)
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Set position independent code
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 if(RESPOND_BUILD_PIC)
     set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 endif()
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Building the Library
-# ---------------------------------------------------------------------------------------
-set(RESPOND_SRCS 
-    src/markov.cpp
-    src/logging.cpp
-)
+#-------------------------------------------------------------------------------
+add_library(respond_model)
+add_library(respond::respond_model ALIAS respond_model)
 
-if(RESPOND_BUILD_SHARED_LIBS)
-    if(WIN32)
-        configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc @ONLY)
-        list(APPEND RESPOND_SRCS ${CMAKE_CURRENT_BINARY_DIR}/version.rc)
-    endif()
-    add_library(respond SHARED ${RESPOND_SRCS} ${RESPOND_ALL_HEADERS})
-    target_compile_definitions(respond PUBLIC RESPOND_SHARED_LIB)
-    if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
-        target_compile_options(respond PUBLIC $<$<AND:$<CXX_COMPILER_ID:MSVC>,$<NOT:$<COMPILE_LANGUAGE:CUDA>>>:/wd4251
-                                             /wd4275>)
-    endif()
-else()
-    add_library(respond STATIC ${RESPOND_SRCS} ${RESPOND_ALL_HEADERS})
-endif()
-
-# ---------------------------------------------------------------------------------------
-# Alias for importing
-# ---------------------------------------------------------------------------------------
-add_library(respond::respond ALIAS respond)
+target_sources(respond_model
+    PRIVATE
+        src/markov.cpp
+        src/logging.cpp
+        src/internals/logging_internals.hpp
+        src/internals/markov_internals.hpp
 
-set(RESPOND_INCLUDES_LEVEL "")
-if(RESPOND_SYSTEM_INCLUDES)
-    set(RESPOND_INCLUDES_LEVEL "SYSTEM")
-endif()
+    PUBLIC
+        FILE_SET HEADERS
+        BASE_DIRS
+            include
+        FILES
+            include/respond/cost_effectiveness.hpp
+            include/respond/helpers.hpp
+            include/respond/logging.hpp
+            include/respond/markov.hpp
+            include/respond/respond.hpp
+            include/respond/types.hpp
+            include/respond/version.hpp
+    )
 
-target_compile_definitions(respond PUBLIC RESPOND_COMPILED_LIB)
-target_include_directories(respond ${RESPOND_INCLUDES_LEVEL} PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>"
-"$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>" PRIVATE 
-"$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/src>")
+include(${PRIVATE_MODULE_PATH}/MakeDependenciesAvailable.cmake)
 
-include(MakeDependenciesAvailable)
+set(private_deps spdlog::spdlog)
 
 if (RESPOND_CALCULATE_COVERAGE)
-    target_link_libraries(respond
-    PUBLIC
-        Eigen3::Eigen
-    PRIVATE
-        spdlog::spdlog
-        gcov
-    )
-else()
-    target_link_libraries(respond
-    PUBLIC
-        Eigen3::Eigen
-    PRIVATE
-        spdlog::spdlog
-    )
+    list(APPEND private_deps gcov)
 endif()
 
-set_target_properties(respond PROPERTIES VERSION ${RESPOND_VERSION} SOVERSION ${RESPOND_VERSION_MAJOR}.${RESPOND_VERSION_MINOR})
+target_link_libraries(respond_model
+PUBLIC
+    Eigen3::Eigen
+PRIVATE
+    ${private_deps}
+)
 
-include(BuildBinaries)
+set_target_properties(respond_model PROPERTIES VERSION ${RESPOND_VERSION} SOVERSION ${RESPOND_VERSION_MAJOR}.${RESPOND_VERSION_MINOR})
 
-# ---------------------------------------------------------------------------------------
+include(${PRIVATE_MODULE_PATH}/BuildBinaries.cmake)
+
+#-------------------------------------------------------------------------------
 # Install
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
+include(GNUInstallDirs)
 if(RESPOND_INSTALL)
-    include(InstallRespond)
+    include(${PRIVATE_MODULE_PATH}/InstallRespond.cmake)
 endif()

CMakePresets.json

@@ -47,7 +47,6 @@
                 "RESPOND_BUILD_TESTS": "ON",
                 "RESPOND_CALCULATE_COVERAGE": "ON",
                 "RESPOND_BUILD_BENCH": "OFF",
-                "RESPOND_BUILD_SHARED_LIBS": "OFF",
                 "RESPOND_BUILD_WARNINGS": "ON",
                 "RESPOND_SYSTEM_INCLUDES": "OFF",
                 "RESPOND_INSTALL": "OFF",
@@ -64,12 +63,10 @@
                 "RESPOND_BUILD_TESTS": "OFF",
                 "RESPOND_CALCULATE_COVERAGE": "OFF",
                 "RESPOND_BUILD_BENCH": "OFF",
-                "RESPOND_BUILD_SHARED_LIBS": "OFF",
                 "RESPOND_BUILD_WARNINGS": "OFF",
                 "RESPOND_SYSTEM_INCLUDES": "OFF",
                 "RESPOND_INSTALL": "ON",
-                "RESPOND_NO_EXCEPTIONS": "OFF",
-                "RESPOND_RUN_OMP": "ON"
+                "RESPOND_NO_EXCEPTIONS": "OFF"
             },
             "warnings": {
                 "dev": false
@@ -169,7 +166,8 @@
             "name": "gcc-release",
             "configurePreset": "gcc-release",
             "generators": [
-                "TGZ"
+                "TGZ",
+                "DEB"
             ]
         }
     ],

README.md

@@ -1,4 +1,5 @@
-# ⚠ NOTICE ⚠
+# :warning: NOTICE :warning:
+
 This repository is under active development and is not currently in a state for public use. If you wish to use RESPOND, please refer to release [v0.3.0](https://github.com/SyndemicsLab/respond/releases/tag/v0.3.0) for a functioning executable.
 
 # RESPOND: An Opioid Use Disorder State Transition Model
@@ -9,7 +10,7 @@ This repository is under active development and is not currently in a state for
 [![Tests](https://github.com/SyndemicsLab/respond/actions/workflows/test-ubuntu.yml/badge.svg)](https://github.com/SyndemicsLab/respond/actions/workflows/test-ubuntu.yml)
 [![Coverage](https://github.com/SyndemicsLab/respond/actions/workflows/coverage.yml/badge.svg)](https://github.com/SyndemicsLab/respond/actions/workflows/coverage.yml)
 
-This is the home of the [RESPOND model](https://syndemicslab.github.io/respond)[1], first created by the [Syndemics Lab](https://www.syndemicslab.org) in 2018, now rewritten with a focus on four primary goals:
+This is the home of the [RESPOND model](https://syndemicslab.github.io/respond) [1], first created by the [Syndemics Lab](https://www.syndemicslab.org) in 2018, now rewritten with a focus on four primary goals:
 
 1. Improve the Maintainability/Scalability of the Model
 2. Improve the Overall Efficiency of the Model
@@ -46,6 +47,7 @@ The required dependencies are:
 - [spdlog](https://github.com/gabime/spdlog)
 
 Building tests is optional, but when doing so it requires:
+
 - [GoogleTest](https://github.com/google/googletest)
 
 ### Local
@@ -60,6 +62,22 @@ cmake --workflow --preset gcc-release
 
 And then the model is build and installed. Our default location is a build directory in the repository, but the CMake Install Directory can be pointed to wherever the user desires.
 
+## Installation
+
+As this is a library, we are currently working on expanding the ability to install and work with RESPOND. If building a new project using CMake we encourage the use of `FetchContent`. However, we do also provide debian and tarball installations as well. We are currently working on building a Windows executable as well.
+
+### Debian
+
+To access our Debian installer, please navigate to the [release](https://github.com/SyndemicsLab/respond/releases) you wish to install and download the Debian package (`.deb`).
+
+From there, a simple
+
+```bash
+sudo dpkg -i respond-xxx.deb
+```  
+
+command will result in the appropriate installation. The only files added are the public headers, the compiled static library, and the CMake configuration files.
+
 ### FetchContent
 
 If you would like to make use of Fetch Content to extract the library:
@@ -69,16 +87,21 @@ include(FetchContent)
 FetchContent_Declare(
     respond
     GIT_REPOSITORY https://github.com/SyndemicsLab/respond.git
-    GIT_TAG main
+    GIT_TAG 5d4dde64b2e1f4ca4cea26851b82000379dbf7cb
+    OVERRIDE_FIND_PACKAGE
+)
+set(RESPOND_INSTALL ON)
+find_package(respond REQUIRED)
+
+target_link_libraries(${PROJECT_NAME}
+    PRIVATE
+        respond::respond_model
 )
-option(RESPOND_INSTALL "Enable install for respond project" ON)
-option(RESPOND_BUILD_TESTS "Disable testing for RESPOND" OFF)
-FetchContent_MakeAvailable(respond)
 ```
 
 ### Script
 
-If you would prefer a single, all in one, script. Our team has developed a script that works on any Linux environment and finds packages wherever available. As such, the user need simply run:
+If you would prefer a single bash script to add the project to the build tree, run:
 
 ```shell
 ./tools/build.sh

cmake/InstallRespond.cmake

@@ -1,56 +1,58 @@
-message(STATUS "Installing respond")
-set(project_config_in "${CMAKE_CURRENT_LIST_DIR}/respondConfig.cmake.in")
-set(project_config_out "${CMAKE_CURRENT_BINARY_DIR}/respondConfig.cmake")
-set(config_targets_file "respondConfigTargets.cmake")
+message(STATUS "Installing respond version ${RESPOND_VERSION}...")
+
+set(export_dest_dir "${CMAKE_INSTALL_LIBDIR}/respond")
+set(export_cmake_dir "${CMAKE_INSTALL_LIBDIR}/cmake/respond")
 set(version_config_file "${CMAKE_CURRENT_BINARY_DIR}/respondConfigVersion.cmake")
-set(export_dest_dir "${CMAKE_INSTALL_LIBDIR}/cmake/respond")
-set(pkgconfig_install_dir "${CMAKE_INSTALL_LIBDIR}/pkgconfig")
-set(pkg_config "${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pc")
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Include files
-# ---------------------------------------------------------------------------------------
-install(DIRECTORY include/ DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
+#-------------------------------------------------------------------------------
+message("Installing respond to ${CMAKE_INSTALL_FULL_LIBDIR} and ${CMAKE_INSTALL_FULL_INCLUDEDIR}...")
+
+install(
+    TARGETS respond_model
+    EXPORT respondTargets
+    FILE_SET HEADERS
+)
+
 install(
-    TARGETS respond
-    EXPORT respond
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
-
-# ---------------------------------------------------------------------------------------
-# Install pkg-config file
-# ---------------------------------------------------------------------------------------
-if(IS_ABSOLUTE "${CMAKE_INSTALL_INCLUDEDIR}")
-    set(PKG_CONFIG_INCLUDEDIR "${CMAKE_INSTALL_INCLUDEDIR}")
-else()
-    set(PKG_CONFIG_INCLUDEDIR "\${prefix}/${CMAKE_INSTALL_INCLUDEDIR}")
-endif()
-if(IS_ABSOLUTE "${CMAKE_INSTALL_LIBDIR}")
-    set(PKG_CONFIG_LIBDIR "${CMAKE_INSTALL_LIBDIR}")
-else()
-    set(PKG_CONFIG_LIBDIR "\${exec_prefix}/${CMAKE_INSTALL_LIBDIR}")
-endif()
-get_target_property(PKG_CONFIG_DEFINES respond INTERFACE_COMPILE_DEFINITIONS)
-string(REPLACE ";" " -D" PKG_CONFIG_DEFINES "${PKG_CONFIG_DEFINES}")
-string(CONCAT PKG_CONFIG_DEFINES "-D" "${PKG_CONFIG_DEFINES}")
-configure_file("cmake/${PROJECT_NAME}.pc.in" "${pkg_config}" @ONLY)
-install(FILES "${pkg_config}" DESTINATION "${pkgconfig_install_dir}")
-
-# ---------------------------------------------------------------------------------------
-# Install CMake config files
-# ---------------------------------------------------------------------------------------
-export(TARGETS respond NAMESPACE respond::
-    FILE "${CMAKE_CURRENT_BINARY_DIR}/${config_targets_file}")
-install(EXPORT respond DESTINATION ${export_dest_dir} NAMESPACE respond:: FILE ${config_targets_file})
+    EXPORT respondTargets
+    DESTINATION ${export_cmake_dir}
+    NAMESPACE respond::
+)
 
 include(CMakePackageConfigHelpers)
-configure_package_config_file("${project_config_in}" "${project_config_out}" INSTALL_DESTINATION ${export_dest_dir})
 
-write_basic_package_version_file("${version_config_file}" COMPATIBILITY SameMajorVersion)
-install(FILES "${project_config_out}" "${version_config_file}" DESTINATION "${export_dest_dir}")
+configure_file(
+    "${PROJECT_SOURCE_DIR}/cmake/respondConfig.cmake.in"
+    "${PROJECT_BINARY_DIR}/respondConfig.cmake"
+    @ONLY
+)
+set(project_config "${PROJECT_BINARY_DIR}/respondConfig.cmake")
+
+write_basic_package_version_file(
+  ${version_config_file}
+  COMPATIBILITY ExactVersion
+)
+
+install(
+    FILES
+        ${project_config}
+        ${version_config_file}
+    DESTINATION ${export_cmake_dir}
+)
+
+#-------------------------------------------------------------------------------
+# CPack Options for RESPOND
+#-------------------------------------------------------------------------------
+configure_file(
+    "${PROJECT_SOURCE_DIR}/cmake/respondCPackOptions.cmake.in"
+    "${PROJECT_BINARY_DIR}/respondCPackOptions.cmake"
+    @ONLY
+)
+set(CPACK_PROJECT_CONFIG_FILE "${PROJECT_BINARY_DIR}/respondCPackOptions.cmake")
 
-# ---------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Support creation of installable packages
-# ---------------------------------------------------------------------------------------
-include(cmake/respondCPack.cmake)
+#-------------------------------------------------------------------------------
+include(CPack)