Merge pull request #124 from WardF/param_git_tag.wif

Parameterize dependencies to allow for easier testing against PRs, branches.

Author: WardF

README.md

@@ -27,6 +27,37 @@ Pre-made grids for use in MUSICA are available [here](https://wiki.ucar.edu/disp
 Checkout our [software development plan](docs/Software%20Development%20Plan.pdf)
 to see how you can contribute new science to MUSICA software.
 
+## Developer Options
+
+### Specifying dependency versions via paramaterization at configure time
+
+Introduced in [Pull Request #124](https://github.com/NCAR/musica/pull/124), it is possible for developers to specify which versions of various dependencies should be used. These options are currently limited to those dependencies managed via `FetchContent`.  This change allows for more easily testing `musica` against changes committed in different repositories and branches.  The environmental variables introduced are outlined in the following table. 
+
+#### CMake Dependency Variables
+
+| Musica Dependency                                      | Repository                | Branch, Tag or Hash|
+| ------------------------------------------------------ | --------------------------|--------------------|
+| [Google Test](https://github.com/google/googletest.git)| GOOGLETEST_GIT_REPOSITORY | GOOGLETEST_GIT_TAG |
+| [MICM](https://github.com/NCAR/mcim.git)               | MICM_GIT_REPOSITORY       | MICM_GIT_TAG       | 
+| [TUV-X](https://github.com/NCAR/tuv-x.git)             | TUVX_GIT_REPOSITORY       | TUVX_GIT_TAG       |
+| [PyBind11](https://github.com/pybind/pybind11)         | PYBIND11_GIT_REPOSITORY   | PYBIND11_GIT_TAG   |
+
+#### Example Usage
+
+> The following examples assume the working directory is a `build/` directory inside the `musica` source directory.
+
+Specifying a different version of `tuv-x`, to ensure a change won't break anything.
+
+    $ cmake .. \
+        -DTUVX_GIT_REPOSITORY="https://github.com/WardF/tuv-x.git" \
+        -DTUVX_GIT_TAG=test-fix
+
+Specifying a specific version of `tuv-x` by has, but using the official repository.
+
+    $ cmake .. \
+        -DTUVX_GIT_TAG=a6b2c4d8745
+
+
 ## Citing MUSICA
 
 MUSICA can be cited in at least two ways. The first is to cite [the paper](https://doi.org/10.1175/BAMS-D-19-0331.1) that defines the vision

cmake/dependencies.cmake

@@ -1,5 +1,17 @@
 include(FetchContent)
 
+
+################################################################################
+# Function to reduce repeated code, set a value to a variable only if the
+# variable is not already defined. 
+function(set_git_default git_var git_val)
+
+  if(NOT ${git_var})
+    set(${git_var} ${git_val} PARENT_SCOPE)
+  endif()
+
+endfunction(set_git_default)
+
 ################################################################################
 # NetCDF library
 if (MUSICA_BUILD_FORTRAN_INTERFACE)
@@ -10,9 +22,14 @@ endif()
 ################################################################################
 # google test
 if(MUSICA_ENABLE_TESTS)
+
+  set_git_default(GOOGLETEST_GIT_REPOSITORY https://github.com/google/googletest.git)
+  set_git_default(GOOGLETEST_GIT_TAG be03d00f5f0cc3a997d1a368bee8a1fe93651f48)
+
   FetchContent_Declare(googletest
-    GIT_REPOSITORY https://github.com/google/googletest.git
-    GIT_TAG be03d00f5f0cc3a997d1a368bee8a1fe93651f48
+    GIT_REPOSITORY ${GOOGLETEST_GIT_REPOSITORY}
+    GIT_TAG ${GOOGLETEST_GIT_TAG}
+    GIT_PROGRESS NOT ${FETCHCONTENT_QUIET}
   )
 
   set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
@@ -31,9 +48,14 @@ endif()
 # MICM
 
 if (MUSICA_ENABLE_MICM AND MUSICA_BUILD_C_CXX_INTERFACE)
+
+  set_git_default(MICM_GIT_REPOSITORY https://github.com/NCAR/micm.git)
+  set_git_default(MICM_GIT_TAG 2a5cd4e11a6973974f3c584dfa9841d70e0a42d5)
+
   FetchContent_Declare(micm
-      GIT_REPOSITORY https://github.com/NCAR/micm.git
-      GIT_TAG 8c4cff0d
+      GIT_REPOSITORY ${MICM_GIT_REPOSITORY}
+      GIT_TAG ${MICM_GIT_TAG}
+      GIT_PROGRESS NOT ${FETCHCONTENT_QUIET}
   )
   set(MICM_ENABLE_TESTS OFF)
   set(MICM_ENABLE_EXAMPLES OFF)
@@ -50,9 +72,13 @@ if (MUSICA_ENABLE_TUVX AND MUSICA_BUILD_C_CXX_INTERFACE)
   set(TUVX_INSTALL_MOD_DIR ${MUSICA_INSTALL_INCLUDE_DIR} CACHE STRING "" FORCE)
   set(TUVX_INSTALL_INCLUDE_DIR ${MUSICA_INSTALL_INCLUDE_DIR} CACHE STRING "" FORCE)
 
+  set_git_default(TUVX_GIT_REPOSITORY https://github.com/NCAR/tuv-x.git)
+  set_git_default(TUVX_GIT_TAG 6ff27992da1485392329208b736d2ec1522dafa3)
+
   FetchContent_Declare(tuvx
-    GIT_REPOSITORY https://github.com/NCAR/tuv-x.git
-    GIT_TAG 6ff27992da1485392329208b736d2ec1522dafa3
+    GIT_REPOSITORY ${TUVX_GIT_REPOSITORY}
+    GIT_TAG ${TUVX_GIT_TAG}
+    GIT_PROGRESS NOT ${FETCHCONTENT_QUIET}
   )
 
   FetchContent_MakeAvailable(tuvx)
@@ -63,9 +89,13 @@ endif()
 if(MUSICA_ENABLE_PYTHON_LIBRARY)
   set(PYBIND11_NEWPYTHON ON)
 
+  set_git_default(PYBIND11_GIT_REPOSITORY https://github.com/pybind/pybind11)
+  set_git_default(PYBIND11_GIT_TAG v2.12.0)
+
   FetchContent_Declare(pybind11
-      GIT_REPOSITORY https://github.com/pybind/pybind11
-      GIT_TAG        v2.12.0
+      GIT_REPOSITORY ${PYBIND11_GIT_REPOSITORY}
+      GIT_TAG        ${PYBIND11_GIT_TAG}
+      GIT_PROGRESS  NOT ${FETCHCONTENT_QUIET}
   )
 
   FetchContent_GetProperties(pybind11)