Merge topic 'catalyst-module'

e09b34f9 Add changelog
26b22725 Add VTK::catalyst module

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: buildbot <buildbot@kitware.com>
Merge-request: !10932

CMakeLists.txt

@@ -228,7 +228,7 @@ endif ()
 
 #-----------------------------------------------------------------------------
 # Add an option to enable/disable catalyst2 support.
-option(VTK_ENABLE_CATALYST "Build IOCatalystConduit module and VTK catalyst implementation." OFF)
+option(VTK_ENABLE_CATALYST "Build catalyst-dependent modules, including the VTK catalyst implementation." OFF)
 mark_as_advanced(VTK_ENABLE_CATALYST)
 
 #-----------------------------------------------------------------------------
@@ -302,17 +302,23 @@ endif ()
 if (VTK_ENABLE_LOGGING)
   list(APPEND vtk_requested_modules
     VTK::loguru)
-  set("_vtk_module_reason_VTK::loguru"
-    "via `VTK_ENABLE_LOGGING`")
+else ()
+  list(APPEND vtk_rejected_modules
+    VTK::loguru)
 endif ()
+set("_vtk_module_reason_VTK::loguru"
+  "via `VTK_ENABLE_LOGGING`")
 if (VTK_ENABLE_CATALYST)
+  list(APPEND vtk_requested_modules
+    VTK::catalyst)
+  # This is kept because it may be how users are enabling the module today.
   list(APPEND vtk_requested_modules
     VTK::IOCatalystConduit)
-else()
+else ()
   list(APPEND vtk_rejected_modules
-    VTK::IOCatalystConduit)
-endif()
-set("_vtk_module_reason_VTK::IOCatalystConduit"
+    VTK::catalyst)
+endif ()
+set("_vtk_module_reason_VTK::catalyst"
   "via `VTK_ENABLE_CATALYST`")
 if (VTK_ENABLE_WEBGPU)
   list(APPEND vtk_requested_modules

Documentation/docs/build_instructions/build_settings.md

@@ -35,8 +35,8 @@ Less common, but variables which may be of interest to some:
     will be implemented by default. Must be either `Sequential`, `STDThread`,
     `OpenMP` or `TBB`. The backend can be changed at runtime if the desired
     backend has his option `VTK_SMP_ENABLE_<backend_name>` set to `ON`.
-  * `VTK_ENABLE_CATALYST` (default `OFF`): Enable the CatlystConduit module
-  and build the VTK Catalyst implementation. Depends on an external Catalyst.
+  * `VTK_ENABLE_CATALYST` (default `OFF`): Enable catalyst-dependent modules
+    including the VTK catalyst implementation. Depends on an external Catalyst.
 
 OpenGL-related options:
 

Documentation/release/dev/add-catalyst-module.md

+## Add VTK::catalyst module
+
+VTK now has a new module called `VTK::catalyst` which is enabled with VTK_ENABLE_CATALYST,
+It looks for an external Catalyst installation and exposes catalyst's CMake functionality.
+Other VTK modules, such as `VTK::IOCatalystConduit`, can now depend on `VTK::catalyst` instead
+of trying to find the Catalyst package themselves.

IO/CatalystConduit/CMakeLists.txt

@@ -4,17 +4,8 @@ set(classes
   vtkConduitToDataObject
   vtkDataObjectToConduit)
 
-# SDK component is required for Catalyst implementation (see Catalyst subdir)
-vtk_module_find_package(PACKAGE catalyst VERSION 2.0 COMPONENTS SDK)
-
-set_property(GLOBAL PROPERTY vtk_catalyst_dir_primary "${catalyst_DIR}")
-
 vtk_module_add_module(VTK::IOCatalystConduit
   CLASSES ${classes})
 
-vtk_module_link(VTK::IOCatalystConduit
-  PUBLIC
-    catalyst::catalyst)
-
 vtk_add_test_mangling(VTK::IOCatalystConduit)
 add_subdirectory(Catalyst)

IO/CatalystConduit/Catalyst/CMakeLists.txt

@@ -27,7 +27,7 @@ catalyst_implementation(
     "${catalyst_library_destination}"
   SOURCES
     VTKCatalyst.cxx
-  CATALYST_TARGET catalyst::catalyst)
+  CATALYST_TARGET VTK::catalyst)
 
 add_library(VTK::catalyst-vtk ALIAS catalyst-vtk)
 

IO/CatalystConduit/vtk.module

@@ -13,6 +13,7 @@ SPDX_COPYRIGHT_TEXT
 DEPENDS
   VTK::CommonDataModel
   VTK::CommonExecutionModel
+  VTK::catalyst
 PRIVATE_DEPENDS
   VTK::FiltersCore
   VTK::FiltersAMR

Utilities/Catalyst/CMakeLists.txt

+vtk_module_third_party_external(
+  PACKAGE catalyst
+  COMPONENTS SDK
+  TARGETS catalyst::catalyst
+  VERSION "2.0")

Utilities/Catalyst/vtk.module

+NAME
+  VTK::catalyst
+LIBRARY_NAME
+  vtkcatalyst
+THIRD_PARTY