Merge pull request #2600 from opensim-org/opensim-copy-dependencies-with-wrapping

OPENSIM_COPY_DEPENDENCIES with wrapping

Author: chrisdembia

CHANGELOG.md

@@ -45,6 +45,7 @@ Other Changes
 building and simulating a simple arm model;  using OutputReporters to record and write marker location and coordinate values to file.
 - Added Python example that demonstrates how to run an optimization using the cma package and how to avoid an expensive call to `initSystem()` within the objective function. (PR #2604)
 - OpenSim 4.1 ships with Python3 bindings as default. It is still possible to create bindings for Python2 if desired by setting CMake variable OPENSIM_PYTHON_VERSION to 2
+- For CMake, the option OPENSIM_COPY_DEPENDENCIES option is now an advanced option, and a warning is provided if this option is off but wrapping is turned on.
 
 v4.0
 ====

CMakeLists.txt

@@ -89,7 +89,9 @@ option(OPENSIM_COPY_DEPENDENCIES "Copy Simbody and BTK into the
 OpenSim installation. This should be set to ON when making a relocatable
 distribution, and should be set to OFF when packaging for Homebrew, Debian,
 etc. On Linux and macOS: we use relative RPATHs when ON, and absolute RPATHs
-when OFF." ON)
+when OFF. For most users, this should also be on if BUILD_JAVA_WRAPPING or 
+BUILD_PYTHON_WRAPPING is ON, so if this OFF, a warning is thrown." ON)
+mark_as_advanced(OPENSIM_COPY_DEPENDENCIES)
 
 option(OPENSIM_PYTHON_STANDALONE "Make the Python package standalone, meaning
 the OpenSim (and Simbody and BTK) shared libraries it depends on are copied
@@ -440,6 +442,15 @@ if(${BUILD_JAVA_WRAPPING})
             endif()
         endif()
     endif()
+    # Most users need to copy dependencies if wrapping is on. Warn user
+    # if it isn't on.
+    if (NOT OPENSIM_COPY_DEPENDENCIES)
+        string(CONCAT MSG
+           "BUILD_JAVA_WRAPPING is ON but OPENSIM_COPY_DEPENDENCIES is OFF. "
+           "Wrapping may not work correctly. Consider switching the "
+           "OPENSIM_COPY_DEPENDENCIES flag to ON.")
+        message(WARNING ${MSG})
+    endif()
 endif()
 
 if(${BUILD_PYTHON_WRAPPING})
@@ -488,7 +499,16 @@ if(${BUILD_PYTHON_WRAPPING})
             CACHE FILEPATH "${pylib_desc}")
     endif()
     find_package(PythonLibs ${required_python_version} REQUIRED)
-
+    
+    # Most users need to copy dependencies if wrapping is on. Warn user
+    # if it isn't on.
+    if (NOT OPENSIM_COPY_DEPENDENCIES)
+        string(CONCAT MSG
+           "BUILD_PYTHON_WRAPPING is ON but OPENSIM_COPY_DEPENDENCIES is OFF. "
+           "Wrapping may not work correctly. Consider switching the "
+           "OPENSIM_COPY_DEPENDENCIES flag to ON.")
+        message(WARNING ${MSG})
+    endif()
 endif()
 
 if(WIN32)