Feature/enable development files installation #1285

RafaelPalomar · 2019-12-12T21:23:03Z

Hello. Here some patches to make development files installable.

pieper · 2019-12-12T21:31:54Z

Hi - What's the context for wanting the developer files? Does this also package them? (i.e. make them part of the installer?)

jcfr · 2019-12-12T21:32:37Z

Thanks for your contribution 🙏

In the coming days, I will carefully review your changes and start to selectively integrate them. If any, I will post questions here.

Note: If by Tuesday evening, I have not posted an update. Make sure to comment back on this issue to remind us.

lassoan · 2019-12-12T22:15:16Z

Will this allow building C++ loadable modules without building Slicer?

Currently the Slicer_INSTALL_DEVELOPMENT option is set to OFF. These changes will enable Slicer_INSTALL_DEVELOPMENT as an option that can be set ON/OFF.

With the following options: -DSlicer_SUPERBUILD=OFF -DBUILD_TESTING=OFF -DSlicer_BUILD_EXTENSIONMANAGER_SUPPORT=OFF -DSlicer_BUILD_CLI_SUPPORT=OFF -DSlicer_BUILD_CLI=OFF -DCMAKE_CXX_STANDARD=11 -DSlicer_REQUIRED_QT_VERSION=5 -DSlicer_BUILD_DICOM_SUPPORT=OFF -DSlicer_BUILD_ITKPython=OFF -DSlicer_BUILD_QTLOADABLEMODULES=OFF -DSlicer_BUILD_QT_DESIGNER_PLUGINS=OFF -DSlicer_USE_CTKAPPLAUNCHER=OFF -DSlicer_USE_PYTHONQT=OFF -DSlicer_USE_QtTesting=OFF -DSlicer_USE_SimpleITK=OFF -DSlicer_VTK_RENDERING_BACKEND=OpenGL2 -DSlicer_VTK_VERSION_MAJOR=8 -DSlicer_INSTALL_DEVELOPMENT=ON -DCMAKE_INSTALL_RPATH=/usr/lib64/Slicer-4.11:/usr/lib64/ctk-0.1:/usr/lib64/Slicer-4.11/qt-loadable-modules:/usr/lib64/ITK-5.1.0 -DCMAKE_BUILD_WITH_INSTALL_RPATH=ON -DSlicer_USE_SYSTEM_LibArchive=ON -DTeem_DIR=/usr/lib64 -DjqPlot_DIR=/usr/share/jqPlot The following error raises: [100%] Built target SlicerApp Install the project... -- Install configuration: "Gentoo" CMake Error at cmake_install.cmake:41 (file): file INSTALL cannot find "/var/tmp/portage/sci-medical/3DSlicer-9999/work/3DSlicer-9999/vtkSlicerConfigure.h". This is due an error on the specification of the origin/destination paths.

With the following configuration: -DSlicer_SUPERBUILD=OFF -DBUILD_TESTING=OFF -DSlicer_BUILD_EXTENSIONMANAGER_SUPPORT=OFF -DSlicer_BUILD_CLI_SUPPORT=OFF -DSlicer_BUILD_CLI=OFF -DCMAKE_CXX_STANDARD=11 -DSlicer_REQUIRED_QT_VERSION=5 -DSlicer_BUILD_DICOM_SUPPORT=OFF -DSlicer_BUILD_ITKPython=OFF -DSlicer_BUILD_QTLOADABLEMODULES=OFF -DSlicer_BUILD_QT_DESIGNER_PLUGINS=OFF -DSlicer_USE_CTKAPPLAUNCHER=OFF -DSlicer_USE_PYTHONQT=OFF -DSlicer_USE_QtTesting=OFF -DSlicer_USE_SimpleITK=OFF -DSlicer_VTK_RENDERING_BACKEND=OpenGL2 -DSlicer_VTK_VERSION_MAJOR=8 -DSlicer_INSTALL_DEVELOPMENT=ON -DCMAKE_INSTALL_RPATH=/usr/lib64/Slicer-4.11:/usr/lib64/ctk-0.1:/usr/lib64/Slicer-4.11/qt-loadable-modules:/usr/lib64/ITK-5.1.0 -DCMAKE_BUILD_WITH_INSTALL_RPATH=ON -DSlicer_USE_SYSTEM_LibArchive=ON -DTeem_DIR=/usr/lib64 -DjqPlot_DIR=/usr/share/jqPlot the following error raises: CMake Error at Base/QTCore/Testing/Python/cmake_install.cmake:41 (file): file INSTALL cannot find "/var/tmp/portage/sci-medical/3DSlicer-9999/work/3DSlicer-9999_build/Base/QTCore/Testing/Python/qSlicerModuleGenericTest.py.in". Call Stack (most recent call first): Base/QTCore/Testing/cmake_install.cmake:43 (include) Base/QTCore/cmake_install.cmake:88 (include) Base/cmake_install.cmake:43 (include) cmake_install.cmake:165 (include) This can be solved by introducing a condition for adding the Python subdirectory in QTCore/Tesitng.

Using the following configuration: -DSlicer_SUPERBUILD=OFF -DBUILD_TESTING=OFF -DSlicer_BUILD_EXTENSIONMANAGER_SUPPORT=OFF -DSlicer_BUILD_CLI_SUPPORT=OFF -DSlicer_BUILD_CLI=OFF -DCMAKE_CXX_STANDARD=11 -DSlicer_REQUIRED_QT_VERSION=5 -DSlicer_BUILD_DICOM_SUPPORT=OFF -DSlicer_BUILD_ITKPython=OFF -DSlicer_BUILD_QTLOADABLEMODULES=OFF -DSlicer_BUILD_QT_DESIGNER_PLUGINS=OFF -DSlicer_USE_CTKAPPLAUNCHER=OFF -DSlicer_USE_PYTHONQT=OFF -DSlicer_USE_QtTesting=OFF -DSlicer_USE_SimpleITK=OFF -DSlicer_VTK_RENDERING_BACKEND=OpenGL2 -DSlicer_VTK_VERSION_MAJOR=8 -DSlicer_INSTALL_DEVELOPMENT=ON -DCMAKE_INSTALL_RPATH=/usr/lib64/Slicer-4.11:/usr/lib64/ctk-0.1:/usr/lib64/Slicer-4.11/qt-loadable-modules:/usr/lib64/ITK-5.1.0 -DCMAKE_BUILD_WITH_INSTALL_RPATH=ON -DSlicer_USE_SYSTEM_LibArchive=ON -DTeem_DIR=/usr/lib64 -DjqPlot_DIR=/usr/share/jqPlot raises the following error: CMake Error at Base/QTGUI/Testing/Cxx/cmake_install.cmake:41 (file): file INSTALL cannot find "/var/tmp/portage/sci-medical/3DSlicer-9999/work/3DSlicer-9999_build/Base/QTGUI/Testing/Cxx/qSlicerUtilsTest1.cxx.in". Call Stack (most recent call first): Base/QTGUI/Testing/cmake_install.cmake:42 (include) Base/QTGUI/cmake_install.cmake:142 (include) Base/cmake_install.cmake:44 (include) cmake_install.cmake:165 (include) This can be solved by changing the path of qSlicerUtilsTest1.cxx.in specified as source for the install command

While there is an option to skip this SlicerBlockAdditionalLauncherSettins, having Slicer_BUILD_CTKAPPLAUNCHER=OFF should also skip it.

Some SlicerBaseQT libraries generate ui_*.h files. With this, these files will be also installed with the rest of development files

RafaelPalomar · 2019-12-13T07:27:43Z

Hi. Thank all you for your quick reply.

@pieper this is in the context of getting the development files installed along the install tree and develops on the use of the Slicer_INSTALL_DEVELOPMENT flag already existing in 3D Slicer. This is useful if one distributes 3D Slicer as an installable binary package that developers could use (e.g., creating new modules). In Debian-based distributions, for instance, this applies to packages ending in "-dev" which contain files needed for development.

@pieper These patches uses CMake infrastructure similar to that used for installing libraries and applications. I would think that, at least, these patches gets us closer to that functionality that you mentioned, but I have not tried since I'm not very familiar with CPack. At least, I built 3D Slicer with Slicer_SUPERBUILD=OFF and Slicer_INSTALL_DEVELOPMENT=ON. After make install I could build loadable modules separately, based on the install tree.

@jcfr I see the tests are not passed (that was unexpected). I will try to fix it before you do the integration. I'll message you when this is done.

@lassoan You have to build Slicer, or at least have the binaries distributed somehow, e.g., install tree in the system directories, since you need to link to some 3D Slicer libraries.

pieper · 2019-12-13T14:11:05Z

Hi @RafaelPalomar - thanks for the extra context. It's a good goal and it would really help developers if we could provide a -dev version of Slicer for easy installation and testing. We have always struggled to integrate Slicer's build with standard packaging for linux because we often find that we need to patch our dependencies (e.g. have a customized version of VTK or ITK with a few fixes).

RafaelPalomar · 2019-12-18T07:15:49Z

Hi @jcfr @pieper @lassoan. Here just a reminder as suggested by @jcfr.
I'm planning to join the Project Week in January. If you have the time, we could have a chat and I could show you what I'm up to with these changes.

pieper · 2019-12-18T13:07:57Z

Yes @RafaelPalomar, a chat a project week is perfect. Please an entry to the project list under Infrastructure so we can flesh out ideas on a project page and link to this PR. https://projectweek.na-mic.org/PW33_2020_GranCanaria/

jcfr · 2020-01-21T14:44:27Z

CMake/UseSlicer.cmake.in

- set(Slicer_INSTALL_CLIMODULES_BIN_DIR "${Slicer_INSTALL_ROOT}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_CLIMODULES_BIN_DIR}")
- set(Slicer_INSTALL_CLIMODULES_LIB_DIR "${Slicer_INSTALL_ROOT}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_CLIMODULES_LIB_DIR}")
- set(Slicer_INSTALL_CLIMODULES_SHARE_DIR "${Slicer_INSTALL_ROOT}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_CLIMODULES_SHARE_DIR}")
+ set(Slicer_INSTALL_CLIMODULES_BIN_DIR "${Slicer_HOME}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_CLIMODULES_BIN_DIR}")


To review more carefully

References:

Slicer_INSTALL_ROOT is set in https://github.com/Slicer/Slicer/blob/59da0db16500d7fbf8b1288748e59c28fad6bab0/CMake/SlicerDirectories.cmake#L66-L71

Slicer_HOME is set in https://github.com/Slicer/Slicer/blob/59da0db16500d7fbf8b1288748e59c28fad6bab0/CMake/SlicerInstallConfig.cmake.in#L38-L39 and https://github.com/Slicer/Slicer/blob/59da0db16500d7fbf8b1288748e59c28fad6bab0/CMakeLists.txt#L706

(note added during the 33rd Slicer Project Week by @RafaelPalomar and @jcfr)

jcfr · 2020-01-21T14:59:02Z

Libs/ITKFactoryRegistration/CMakeLists.txt

@@ -68,7 +68,7 @@ configure_file(
 # Install headers
 # --------------------------------------------------------------------------
 if(NOT DEFINED ${PROJECT_NAME}_INSTALL_NO_DEVELOPMENT)
- set(${PROJECT_NAME}_INSTALL_NO_DEVELOPMENT ON)
+ set(${PROJECT_NAME}_INSTALL_NO_DEVELOPMENT ${Slicer_INSTALL_NO_DEVELOPMENT})


This should already be set in https://github.com/Slicer/Slicer/blob/59da0db16500d7fbf8b1288748e59c28fad6bab0/Libs/CMakeLists.txt#L94

jcfr · 2020-01-21T15:01:07Z

Libs/MRML/Widgets/CMakeLists.txt

 endif()
 if(NOT ${PROJECT_NAME}_INSTALL_NO_DEVELOPMENT)
 file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h")
 install(
 FILES ${headers}
 DESTINATION include/${PROJECT_NAME} COMPONENT Development)
+
+ install(FILES
+ ${MRMLWidgets_UI_CXX}


We should revisit this. I don't think these are needed to build modules.

jcfr · 2020-01-21T15:21:52Z

Resources/CMakeLists.txt

@@ -14,19 +14,19 @@ if(NOT Slicer_INSTALL_NO_DEVELOPMENT)
 )

 file(GLOB PNGFILES RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}" "*.png")
- foreach(pngfile ${PNGFILES})


Probably need to keep some version of this.

Rafael Palomar added 14 commits December 13, 2019 07:07

COMP: Enable Slicer_INSTALL_DEVELOPMENT option

77f4ded

Currently the Slicer_INSTALL_DEVELOPMENT option is set to OFF. These changes will enable Slicer_INSTALL_DEVELOPMENT as an option that can be set ON/OFF.

COMP: Generate and Install SlicerConfig (install tree)

647b32d

COMP: Setting CMAKE_MODULE_PATH to account for CTK and Slicer

d277963

COMP: Adding conditional to SlicerBlockAdditionalLauncherSettings

63c0392

While there is an option to skip this SlicerBlockAdditionalLauncherSettins, having Slicer_BUILD_CTKAPPLAUNCHER=OFF should also skip it.

COMP: Add installation of missing files

587268c

COMP: Enable install of development files in Slicer libraries

30cd8fe

COMP: Adding MRML_LIBRARIES variable to install configuration

e88f383

COMP: Change Slicer_ROOT by Slicer_HOME in UseSlicer.cmak.in

6ae59fb

COMP: Add QTLOADABLEMODULES dirs in intall tree configuration

f6e68e7

COMP: Enable installation of generated .h files for BaseQTLibraries

af4bca6

Some SlicerBaseQT libraries generate ui_*.h files. With this, these files will be also installed with the rest of development files

COMP: Enable installation of header files for qMRMLWidgets

d573573

RafaelPalomar force-pushed the feature/enable_development_files_installation branch from bf80d1f to d573573 Compare December 13, 2019 11:13

jcfr reviewed Jan 21, 2020

View reviewed changes

RafaelPalomar closed this Feb 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/enable development files installation #1285

Feature/enable development files installation #1285

RafaelPalomar commented Dec 12, 2019

pieper commented Dec 12, 2019

jcfr commented Dec 12, 2019 •

edited

Loading

lassoan commented Dec 12, 2019

RafaelPalomar commented Dec 13, 2019

pieper commented Dec 13, 2019

RafaelPalomar commented Dec 18, 2019

pieper commented Dec 18, 2019

jcfr Jan 21, 2020 •

edited

Loading

jcfr Jan 21, 2020

jcfr Jan 21, 2020 •

edited

Loading

jcfr Jan 21, 2020

Feature/enable development files installation #1285

Feature/enable development files installation #1285

Conversation

RafaelPalomar commented Dec 12, 2019

pieper commented Dec 12, 2019

jcfr commented Dec 12, 2019 • edited Loading

lassoan commented Dec 12, 2019

RafaelPalomar commented Dec 13, 2019

pieper commented Dec 13, 2019

RafaelPalomar commented Dec 18, 2019

pieper commented Dec 18, 2019

jcfr Jan 21, 2020 • edited Loading

Choose a reason for hiding this comment

jcfr Jan 21, 2020

Choose a reason for hiding this comment

jcfr Jan 21, 2020 • edited Loading

Choose a reason for hiding this comment

jcfr Jan 21, 2020

Choose a reason for hiding this comment

jcfr commented Dec 12, 2019 •

edited

Loading

jcfr Jan 21, 2020 •

edited

Loading

jcfr Jan 21, 2020 •

edited

Loading