ajk/cfebmi_shared_library

CMakeLists.txt

@@ -1,41 +1,52 @@
 cmake_minimum_required(VERSION 3.10)
 
+string(ASCII 27 Esc)
+set(ColourReset "${Esc}[m")
+set(Red         "${Esc}[32m")
+
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
 set(CMAKE_C_COMPILER $ENV{CC})
 set(CMAKE_CXX_COMPILER $ENV{CXX})
 
-string(ASCII 27 Esc)
-set(ColourReset "${Esc}[m")
-set(Red         "${Esc}[31m")
 # module setup options
 
-#option(BASE "BASE" ON)
-
+option(BASE "BASE" OFF)
 option(FORCING "FORCING" OFF)
 option(FORCINGPET "FORCINGPET" OFF)
 option(AETROOTZONE "AETROOTZONE" OFF)
+option(NGEN "NGEN" OFF)
+
+if(NOT BASE AND NOT FORCING AND NOT FORCINGPET AND NOT AETROOTZONE AND NOT NGEN)
+  message("${Red}Options: BASE, FORCING, FORCINGPET, AETROOTZONE, NGEN" ${ColourReset})
+  message(FATAL_ERROR "Invalid option is provided, CMake will exit." )
+endif()
 
-if(FORCING)
-message("${Red} CFE RUNNING WITH FORCING!${ColourReset}")
+if(BASE)
+message("${Red} CFE BUILD 'BASE' CASE!${ColourReset}")
+set(exe_name "cfe_base")
+elseif(FORCING)
+message("${Red} CFE BUILD 'FORCING' CASE!${ColourReset}")
 set(exe_name "cfe_forcing")
 elseif(FORCINGPET)
-message("${Red} CFE RUNNING WITH FORCING AND PET!${ColourReset}")
+message("${Red} CFE BUILD 'FORCING AND PET' CASE!${ColourReset}")
 set(exe_name "cfe_forcingpet")
 elseif(AETROOTZONE)
-message("${Red} CFE RUNNING WITH FORCING AND PET AND ROOTZONE BASED AET TURNED ON!${ColourReset}")
+message("${Red} CFE BUILD 'FORCING AND PET AND ROOTZONE-BASED AET' CASE!${ColourReset}")
 set(exe_name "cfe_aet_rootzone")
-else()
-message("${Red}CFE RUNNING WITH BASE CASE!${ColourReset}")
-set(exe_name "cfe_base")
+elseif(NGEN)
+message("${Red} CFE BUILD NGEN CASE!${ColourReset}")
 endif()
 
-message("generated exe = ${exe_name}")
 # set the project name
-project(cfe)
+project(cfebmi VERSION 1.0.0 DESCRIPTION "OWP CFE BMI Module Shared Library")
 
 set(CMAKE_BUILD_TYPE Debug)
 IF(CMAKE_BUILD_TYPE MATCHES Debug)
     message("Debug build.")
 ENDIF(CMAKE_BUILD_TYPE MATCHES Debug)
+
 message(CMAKE_CXX_COMPILER " ${CMAKE_CXX_COMPILER}")
 message(CMAKE_C_COMPILER " ${CMAKE_C_COMPILER}")
 message("CMAKE_BUILD_TYPE = ${CMAKE_BUILD_TYPE}")
@@ -47,25 +58,65 @@ set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O0")
 
 ## cfe + aorc + pet + smp
 if(AETROOTZONE)
-add_executable(${exe_name} ./src/main_cfe_aorc_pet_rz_aet.cxx ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c ./forcing_code/src/aorc.c ./forcing_code/src/bmi_aorc.c ./forcing_code/src/pet.c ./forcing_code/src/bmi_pet.c)
+add_executable(${exe_name} ./src/main_cfe_aorc_pet_rz_aet.cxx ./src/cfe.c ./src/bmi_cfe.c
+                           ./src/giuh.c ./src/conceptual_reservoir.c ./forcing_code/src/aorc.c
+		           ./forcing_code/src/bmi_aorc.c ./forcing_code/src/pet.c ./forcing_code/src/bmi_pet.c)
 
-add_library(cfelib ./smc_coupler/src/bmi_soil_moisture_profile.cxx ./smc_coupler/src/soil_moisture_profile.cxx ./smc_coupler/include/bmi_soil_moisture_profile.hxx ./smc_coupler/include/soil_moisture_profile.hxx)
+add_library(cfelib ./smc_profiles/src/bmi_soil_moisture_profile.cxx ./smc_profiles/src/soil_moisture_profile.cxx
+                   ./smc_profiles/include/bmi_soil_moisture_profile.hxx ./smc_profiles/include/soil_moisture_profile.hxx)
+target_link_libraries(${exe_name} LINK_PUBLIC cfelib)
 elseif(FORCING)
-add_executable(${exe_name} ./src/main_pass_forcings.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c ./forcing_code/src/aorc.c ./forcing_code/src/bmi_aorc.c)
+add_executable(${exe_name} ./src/main_pass_forcings.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c
+                           ./src/conceptual_reservoir.c ./forcing_code/src/aorc.c ./forcing_code/src/bmi_aorc.c)
 elseif(FORCINGPET)
-add_executable(${exe_name} ./src/main_cfe_aorc_pet.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c ./forcing_code/src/aorc.c ./forcing_code/src/bmi_aorc.c ./forcing_code/src/pet.c ./forcing_code/src/bmi_pet.c)
-else()
+add_executable(${exe_name} ./src/main_cfe_aorc_pet.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c
+                           ./src/conceptual_reservoir.c ./forcing_code/src/aorc.c ./forcing_code/src/bmi_aorc.c
+			   ./forcing_code/src/pet.c ./forcing_code/src/bmi_pet.c)
+elseif(BASE)
 add_executable(${exe_name} ./src/main.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c)
+endif()
+
 
+if(NOT NGEN)
+target_link_libraries(${exe_name} PRIVATE m)
+target_include_directories(${exe_name} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)
 endif()
-if(AETROOTZONE)
-target_link_libraries(${exe_name} LINK_PUBLIC cfelib)
+
+
+# ngen CFE (add shared library)
+if(NGEN)
+set(CFE_LIB_NAME_CMAKE cfebmi)
+set(CFE_LIB_DESC_CMAKE "OWP CFE BMI Module Shared Library")
+
+# Make sure these are compiled with this directive
+add_compile_definitions(BMI_ACTIVE)
+
+if(WIN32)
+    add_library(cfebmi ./src/bmi_cfe.c ./src/cfe.c ./src/giuh.c ./src/conceptual_reservoir.c)
+else()
+    add_library(cfebmi SHARED ./src/bmi_cfe.c ./src/cfe.c ./src/giuh.c ./src/conceptual_reservoir.c)
 endif()
-target_link_libraries(${exe_name} PRIVATE m)
 
-target_include_directories(${exe_name} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+target_include_directories(cfebmi PRIVATE include)
+
+set_target_properties(cfebmi PROPERTIES VERSION ${PROJECT_VERSION})
+
+set_target_properties(cfebmi PROPERTIES PUBLIC_HEADER ./include/bmi_cfe.hxx)
+
+include(GNUInstallDirs)
+
+install(TARGETS cfebmi
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+
+configure_file(cfebmi.pc.in cfebmi.pc @ONLY)
+
+install(FILES ${CMAKE_BINARY_DIR}/cfebmi.pc DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig)
+
+endif()
 
 unset(BASE CACHE)
 unset(FORCING CACHE)
 unset(FORCINGPET CACHE)	
 unset(AETROOTZONE CACHE)
+unset(NGEN CACHE)

README.md

@@ -9,7 +9,7 @@ There are multiple ways to run CFE:
 2. As written by the original author. This includes a full program to read and process atmospheric forcing data, print the model output and check for mass balance closure. This code can be run from the [original_author_code](./original_author_code) directory. This code does not have a BMI implementation.
 
 ## Compiling and Running CFE
-There are four examples for running CFE as described below. They assume you have [GCC](https://gcc.gnu.org) and [CMAKE](https://cmake.org/) on your machine. To build without cmake see section `Alternative: Compiling and Running CFE` below.
+There are four examples for running CFE (out of the nextgen framework) as described below. They assume you have [GCC](https://gcc.gnu.org) and [CMAKE](https://cmake.org/) on your machine. To build without cmake see section `Alternative: Compiling and Running CFE` below.
 
 1. `Option BASE` : CFE reads local forcing data (standalone CFE BMI run; example using one BMI)
 2. `Option FORCING` : CFE uses an external module to read in a forcing file and pass those data using BMI (example using two BMIs)
@@ -19,7 +19,7 @@ There are four examples for running CFE as described below. They assume you have
 ````
 git clone https://github.com/NOAA-OWP/cfe.git
 cd cfe
-git clone https://github.com/NOAA-OWP/SoilMoistureProfiles.git smc_coupler (needed if AETROOTZONE=ON)
+git clone https://github.com/NOAA-OWP/SoilMoistureProfiles.git smc_profiles (needed if AETROOTZONE=ON)
 mkdir build && cd build
 cmake ../ [-DBASE=ON,-DFORCING=ON,-DFORCINGPET=ON,-DAETROOTZONE=ON] (pick one option, e.g. `cmake ../ -DFORCING=ON`)
 make
@@ -28,14 +28,19 @@ run_cfe.sh [BASE, FORCING, FORCINGPET, AETROOTZONE] (pick one option)
 ````
 
 ## Note for running cfe in the ngen framework
-Follow general build instructions [here](https://github.com/NOAA-OWP/ngen/wiki/NGen-Tutorial) and then build [SLoTH](https://github.com/NOAA-OWP/SLoTH) using the following instructions
-```
-cd extern/sloth/ && git checkout latest 
-git submodule update --init --recursive
-cd ../..
-cmake -B extern/sloth/cmake_build -S extern/sloth/
-make -C extern/sloth/cmake_build
+Follow general build instructions [here](https://github.com/NOAA-OWP/ngen/wiki/NGen-Tutorial). Use the following instructions to build CFE and [SLoTH](https://github.com/NOAA-OWP/SLoTH).
 ```
+ CFE
+ - cmake -B extern/cfe/cmake_build -S extern/cfe/cfe/ -DNGEN=ON
+ - make -C extern/cfe/cmake_build
+
+ SLoTH
+ - cd extern/sloth/ && git checkout latest 
+ - git submodule update --init --recursive
+ - cd ../..
+ - cmake -B extern/sloth/cmake_build -S extern/sloth/
+ - make -C extern/sloth/cmake_build
+ ```
 
 ## Note for customized examples (examples different than the above four)
 The configuration files must be passed in this order: (1) the CFE configuration file, (2) the forcing configuration file, (3) the potential evapotranspiration (PET) configuration file, and (4) the soil moisture profile configuration file

cfebmi.pc.in

@@ -0,0 +1,12 @@
+prefix=@CMAKE_INSTALL_PREFIX@
+exec_prefix=@CMAKE_INSTALL_PREFIX@
+libdir=${exec_prefix}/@CMAKE_INSTALL_LIBDIR@
+includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@
+
+Name: @CFE_LIB_NAME_CMAKE@
+Description: @CFE_LIB_DESC_CMAKE@
+Version: @PROJECT_VERSION@
+
+Requires:
+Libs: -L${libdir} -lmylib
+Cflags: -I${includedir}