-
Notifications
You must be signed in to change notification settings - Fork 0
/
CMakeLists.txt
497 lines (441 loc) · 16.7 KB
/
CMakeLists.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
cmake_minimum_required(VERSION 3.8)
project(wsclean)
include(ExternalProject)
include(CMakeVersionInfo.txt)
add_compile_options(
-O3
-Wall
-Wnon-virtual-dtor
-Wzero-as-null-pointer-constant
-Wduplicated-branches
-Wundef
-Wvla
-Wpointer-arith
-Wextra
-Wno-unused-parameter)
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
message(STATUS "Debug build selected: setting linking flag --no-undefined")
string(APPEND CMAKE_SHARED_LINKER_FLAGS " -Wl,--no-undefined")
else()
add_compile_options(-DNDEBUG)
endif()
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED YES)
set(CMAKE_CXX_EXTENSIONS OFF)
option(PORTABLE "Generate portable code" OFF)
option(BUILD_PACKAGES "Build Debian packages" OFF)
include(CheckCXXCompilerFlag)
if(PORTABLE)
if(DEFINED TARGET_CPU)
message(WARNING "You have selected to build PORTABLE binaries. "
"TARGET_CPU settings will be ignored.")
unset(TARGET_CPU CACHE)
endif()
else()
if(DEFINED TARGET_CPU)
add_compile_options(-march=${TARGET_CPU})
set(RADLER_TARGET_CPU "-DTARGET_CPU=${TARGET_CPU}")
else()
check_cxx_compiler_flag("-march=native" COMPILER_HAS_MARCH_NATIVE)
if(COMPILER_HAS_MARCH_NATIVE)
add_compile_options(-march=native)
else()
message(
WARNING "The compiler doesn't support -march=native for your CPU.")
endif()
endif()
endif()
set(ExternalSubmoduleDirectories aocommon pybind11 radler schaapcommon)
foreach(ExternalSubmodule ${ExternalSubmoduleDirectories})
if(NOT EXISTS ${CMAKE_SOURCE_DIR}/external/${ExternalSubmodule})
message(
FATAL_ERROR
"The external submodule '${ExternalSubmodule}' is missing in the external/ subdirectory. "
"This is likely the result of downloading a git tarball without submodules. "
"This is not supported: git tarballs do not provide the required versioning "
"information for the submodules. Please perform a git clone of this repository."
)
endif()
endforeach()
# Find and include git submodules
find_package(Git QUIET)
if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
# Update submodules as needed
option(GIT_SUBMODULE "Check submodules during build" ON)
if(GIT_SUBMODULE)
message(STATUS "Submodule update")
execute_process(
COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive --checkout
--depth 1
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
RESULT_VARIABLE GIT_SUBMOD_RESULT)
if(NOT GIT_SUBMOD_RESULT EQUAL "0")
message(
FATAL_ERROR
"git submodule update --init failed with ${GIT_SUBMOD_RESULT}, please checkout submodules"
)
endif()
endif()
endif()
# Include aocommon
include_directories("${CMAKE_SOURCE_DIR}/external/aocommon/include/")
# Schaapcommon
add_subdirectory("${CMAKE_SOURCE_DIR}/external/schaapcommon")
include_directories("${CMAKE_SOURCE_DIR}/external/schaapcommon/include")
include_directories(external/wgridder)
# Casacore has a separate CMake file in this directory
set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/CMake)
find_package(
HDF5
COMPONENTS C CXX
REQUIRED)
add_definitions(${HDF5_DEFINITIONS})
set(CASACORE_MAKE_REQUIRED_EXTERNALS_OPTIONAL TRUE)
find_package(Casacore REQUIRED COMPONENTS casa ms tables measures fits)
find_package(CFITSIO REQUIRED)
# Chgcentre uses a lapack function. EveryBeam provides lapack, but because
# EveryBeam is not required, chgcentre will fail to link when EveryBeam is not
# available, if LAPACK would not be explicitly required.
find_package(LAPACK REQUIRED)
find_library(FFTW3_LIB fftw3 REQUIRED HINTS ENV FFTW3_LIB)
find_library(FFTW3_THREADS_LIB fftw3_threads REQUIRED HINTS ENV FFTW3_LIB)
find_library(FFTW3F_LIB fftw3f REQUIRED HINTS ENV FFTW3_LIB)
find_library(FFTW3F_THREADS_LIB fftw3f_threads REQUIRED HINTS ENV FFTW3_LIB)
find_path(
FFTW3_INCLUDE_DIR
NAMES fftw3.h
HINTS ENV FFTW3_INCLUDE)
find_package(PythonLibs 3 REQUIRED)
find_package(PythonInterp REQUIRED)
message(STATUS "Using python version ${PYTHON_VERSION_STRING}")
# Include pybind11
add_subdirectory("${CMAKE_SOURCE_DIR}/external/pybind11")
include_directories(SYSTEM ${pybind11_INCLUDE_DIRS})
#Prevent accidentally finding old BoostConfig.cmake file from casapy
set(Boost_NO_BOOST_CMAKE ON)
find_package(
Boost
COMPONENTS date_time filesystem system program_options
REQUIRED)
find_package(Threads REQUIRED)
find_library(DL_LIB dl REQUIRED)
# Once we bump minimum CMake version to >= 3.2, we can use `find_package(GSL REQUIRED)`.
find_library(GSL_LIB NAMES gsl)
find_path(GSL_INCLUDE_DIR NAMES gsl/gsl_version.h)
find_library(GSL_CBLAS_LIB NAMES gslcblas)
if(NOT GSL_LIB
OR NOT GSL_INCLUDE_DIR
OR NOT GSL_CBLAS_LIB)
message(FATAL_ERROR "GSL not found, but required to build WSClean!")
endif()
find_package(MPI)
if(MPI_FOUND)
# FindMPI in CMake >= 3.10 provides MPI_CXX_COMPILE_OPTIONS, a list that can
# be fed into add_compile_options(). In older versions of CMake, FindMPI
# provides MPI_CXX_COMPILE_FLAGS, a white-space separated string that can be
# fed into add_definitions().
if(DEFINED MPI_CXX_COMPILE_OPTIONS)
add_compile_options(${MPI_CXX_COMPILE_OPTIONS})
else()
add_definitions(${MPI_CXX_COMPILE_FLAGS})
endif()
add_definitions(-DHAVE_MPI)
include_directories(SYSTEM ${MPI_INCLUDE_PATH})
set(MPI_CPP_FILES scheduling/mpischeduler.cpp distributed/mpibig.cpp)
else(MPI_FOUND)
message(
WARNING
"MPI not found, multi-processing executable wsclean-mp will not be build."
)
set(MPI_LIBRARIES "")
set(MPI_CPP_FILES)
endif(MPI_FOUND)
find_package(EveryBeam NO_MODULE QUIET)
if(${EVERYBEAM_FOUND})
if(${EVERYBEAM_VERSION} VERSION_LESS "0.5.2" OR ${EVERYBEAM_VERSION}
VERSION_GREATER_EQUAL "0.6.0")
message(STATUS "EveryBeam version is incompatible")
message(
FATAL_ERROR
"WSClean needs EveryBeam version 0.5.x with x>=2 - but found version ${EVERYBEAM_VERSION}"
)
else()
include_directories(${EVERYBEAM_INCLUDE_DIRS})
add_definitions(-DHAVE_EVERYBEAM)
message(STATUS "EveryBeam library found.")
endif()
else(${EVERYBEAM_FOUND})
message(
STATUS
"EveryBeam library not found: Functionality for calculating beams for telescopes such as LOFAR will not be available."
)
set(EVERYBEAM_LIB "")
endif(${EVERYBEAM_FOUND})
find_package(IDGAPI NO_MODULE QUIET)
if(IDGAPI_FOUND)
if(${IDGAPI_VERSION} VERSION_LESS "0.8.1")
message(STATUS "IDG version is incompatible")
message(
FATAL_ERROR
"WSClean needs IDG version 0.8.x - with x >= 1 - but found version ${IDGAPI_VERSION}"
)
else()
set(IDG_FILES idg/idgmsgridder.cpp)
include_directories(${IDGAPI_INCLUDE_DIRS})
add_definitions(-DHAVE_IDG)
message(STATUS "Image domain gridder libraries found.")
endif()
else()
set(IDGAPI_LIBRARIES)
set(IDG_FILES)
message(
STATUS
"Image domain gridder libraries NOT found. This gridder will not be available."
)
endif()
include_directories(SYSTEM ${CASACORE_INCLUDE_DIRS})
include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
include_directories(SYSTEM ${CFITSIO_INCLUDE_DIR})
include_directories(SYSTEM ${FFTW3_INCLUDE_DIR})
include_directories(SYSTEM ${GSL_INCLUDE_DIR})
include_directories(SYSTEM ${HDF5_INCLUDE_DIRS})
include_directories(SYSTEM ${PYTHON_INCLUDE_DIRS})
include(CheckCXXSourceCompiles)
# GSL is required for WSClean, so always available
add_definitions(-DHAVE_GSL)
# Radler
set(RADLER_INSTALL_PREFIX ${CMAKE_BINARY_DIR}/external/radler)
set(RADLER_LIB
${RADLER_INSTALL_PREFIX}/lib/libradler${CMAKE_SHARED_LIBRARY_SUFFIX})
ExternalProject_Add(
radler-module
SOURCE_DIR ${CMAKE_SOURCE_DIR}/external/radler
BINARY_DIR ${CMAKE_BINARY_DIR}/external/radler/build
BUILD_ALWAYS TRUE
BUILD_BYPRODUCTS ${RADLER_LIB}
CMAKE_ARGS
-DCOMPILE_AS_EXTERNAL_PROJECT=On
-DPORTABLE=${PORTABLE}
-DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}
-DCMAKE_INCLUDE_PATH=${CMAKE_INCLUDE_PATH}
-DCMAKE_LIBRARY_PATH=${CMAKE_LIBRARY_PATH}
-DCFITSIO_ROOT_DIR=${CFITSIO_ROOT_DIR}
# The casacore root is set to the location where casacore was found.
# Note that CASACORE_ROOT_DIR isn't set/updated by the find script, so we
# shouldn't set Radler's CASACORE_ROOT_DIR to WSClean's one.
-DCASACORE_ROOT_DIR=${CASACORE_INCLUDE_DIR}/..
-DHDF5_DIR=${HDF5_DIR}
-DAOCOMMON_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/external/aocommon/include/
-DSCHAAPCOMMON_SOURCE_DIR=${CMAKE_SOURCE_DIR}/external/schaapcommon/
-DPYBIND11_SOURCE_DIR=${CMAKE_SOURCE_DIR}/external/pybind11
-DBUILD_TESTING=OFF
-DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
-DCMAKE_INSTALL_PREFIX=${RADLER_INSTALL_PREFIX}
-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
${RADLER_TARGET_CPU})
set(RADLER_INCLUDE_DIR ${RADLER_INSTALL_PREFIX}/include)
include_directories(${RADLER_INCLUDE_DIR})
# The following section will set the "rpath" correctly, so that
# LD_LIBRARY_PATH doesn't have to be set.
# Include GNUInstallDirs for CMAKE_INSTALL_FULL_LIBDIR
include(GNUInstallDirs)
# Use, i.e. don't skip the full RPATH for the build tree.
set(CMAKE_SKIP_BUILD_RPATH FALSE)
# When building, don't use the install RPATH already
# (but later on when installing).
set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
# Add the automatically determined parts of the RPATH
# which point to directories outside the build tree to the install RPATH.
set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
# The RPATH to be used when installing, but only if it's not a system directory.
list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES
"${CMAKE_INSTALL_FULL_LIBDIR}" isSystemDir)
if("${isSystemDir}" STREQUAL "-1")
set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_FULL_LIBDIR}")
endif("${isSystemDir}" STREQUAL "-1")
configure_file("${PROJECT_SOURCE_DIR}/wscversion.h.in"
"${PROJECT_BINARY_DIR}/wscversion.h")
include_directories(${CMAKE_CURRENT_BINARY_DIR})
# Add CPack directory if user wants to generate Debian packages
if(BUILD_PACKAGES)
add_subdirectory(CPack)
endif()
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
# GCC 8.x requires linking with stdc++fs for the filesystem library
# https://gcc.gnu.org/onlinedocs/gcc-9.1.0/libstdc++/manual/manual/status.html#status.iso.2017
if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 8.0)
message(
FATAL_ERROR "The GCC version is too old, upgrade to GCC 8.0 or newer")
elseif(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9.0)
link_libraries(stdc++fs)
endif()
endif()
add_library(
wsclean-object OBJECT
main/commandline.cpp
main/progressbar.cpp
main/stopwatch.cpp
main/wsclean.cpp
main/settings.cpp
gridding/directmsgridder.cpp
gridding/msgridderbase.cpp
gridding/visibilitymodifier.cpp
gridding/wsmsgridder.cpp
gridding/wstackinggridder.cpp
idg/averagebeam.cpp
interface/wscleaninterface.cpp
io/componentlistwriter.cpp
io/facetreader.cpp
io/parsetreader.cpp
io/wscfitswriter.cpp
math/imageoperations.cpp
math/renderer.cpp
math/tophatconvolution.cpp
model/model.cpp
msproviders/averagingmsrowprovider.cpp
msproviders/mscolumns.cpp
msproviders/bdamsrowprovider.cpp
msproviders/contiguousms.cpp
msproviders/msdatadescription.cpp
msproviders/directmsrowprovider.cpp
msproviders/msprovider.cpp
msproviders/msrowprovider.cpp
msproviders/msrowproviderbase.cpp
msproviders/noisemsrowprovider.cpp
msproviders/partitionedms.cpp
msproviders/timestepbuffer.cpp
msproviders/synchronizedms.cpp
msproviders/msreaders/contiguousmsreader.cpp
msproviders/msreaders/partitionedmsreader.cpp
msproviders/msreaders/timestepbufferreader.cpp
msproviders/msweightcolumn.cpp
scheduling/griddingtaskmanager.cpp
scheduling/griddingresult.cpp
scheduling/griddingtask.cpp
scheduling/metadatacache.cpp
scheduling/threadedscheduler.cpp
structures/facetutil.cpp
structures/imageweights.cpp
structures/imagingtable.cpp
structures/imagingtableentry.cpp
structures/msselection.cpp
structures/observationinfo.cpp
structures/primarybeam.cpp
structures/resources.cpp
system/pythonfilepath.cpp
wgridder/wgriddingmsgridder.cpp
wgridder/wgriddinggridder_simple.cpp
external/wgridder/ducc0/math/gridding_kernel.cc
external/wgridder/ducc0/math/gl_integrator.cc
external/wgridder/ducc0/infra/threading.cc
external/wgridder/ducc0/infra/mav.cc
external/wgridder/ducc0/wgridder/wgridder.cc
${IDG_FILES}
${MPI_CPP_FILES})
# A number of files perform the 'core' high-performance floating point
# operations. In these files, NaNs are avoided and thus -ffast-math is
# allowed. Note that visibilities can be NaN hence this can not be turned
# on for all files.
set_source_files_properties(
wsclean/wstackinggridder.cpp wgridder/wgriddinggridder_simple.cpp
PROPERTIES COMPILE_FLAGS -ffast-math)
# Add radler-module dependency to wsclean-object to ensure all
# wsclean targets can link against ${RADLER_LIB}
add_dependencies(wsclean-object radler-module)
set_property(TARGET wsclean-object PROPERTY POSITION_INDEPENDENT_CODE 1)
set(WSCLEANFILES $<TARGET_OBJECTS:wsclean-object>)
set(ALL_LIBRARIES
${CASACORE_LIBRARIES}
${FFTW3_LIB}
${FFTW3_THREADS_LIB}
${FFTW3F_LIB}
${FFTW3F_THREADS_LIB}
${Boost_DATE_TIME_LIBRARY}
${Boost_FILESYSTEM_LIBRARY}
${Boost_PROGRAM_OPTIONS_LIBRARY}
${Boost_SYSTEM_LIBRARY}
${CFITSIO_LIBRARY}
${GSL_LIB}
${GSL_CBLAS_LIB}
Threads::Threads
${IDGAPI_LIBRARIES}
${HDF5_LIBRARIES}
${MPI_LIBRARIES}
${EVERYBEAM_LIB}
schaapcommon)
# Perform the BLAS check from aocommon
include("${CMAKE_CURRENT_LIST_DIR}/external/aocommon/CMake/CheckBLAS.cmake")
check_blas(LIBRARIES ${ALL_LIBRARIES})
# Radler lib cannot be checked on BLAS consistenty as it doesn't exist
# at cmake time.
list(APPEND ALL_LIBRARIES ${RADLER_LIB})
add_library(wsclean-lib STATIC ${WSCLEANFILES})
target_link_libraries(wsclean-lib PRIVATE pybind11::embed ${ALL_LIBRARIES})
set_target_properties(wsclean-lib PROPERTIES OUTPUT_NAME wsclean)
set_target_properties(wsclean-lib PROPERTIES SOVERSION ${WSCLEAN_VERSION_SO})
add_library(wsclean-shared SHARED ${WSCLEANFILES})
target_link_libraries(wsclean-shared PRIVATE pybind11::embed ${ALL_LIBRARIES})
set_target_properties(wsclean-shared PROPERTIES SOVERSION ${WSCLEAN_VERSION_SO})
add_executable(wsclean main/main.cpp)
target_link_libraries(wsclean wsclean-lib)
if(MPI_FOUND)
add_executable(wsclean-mp distributed/wsclean-mp.cpp distributed/worker.cpp)
target_link_libraries(wsclean-mp wsclean-lib)
endif(MPI_FOUND)
add_executable(chgcentre chgcentre/main.cpp chgcentre/progressbar.cpp)
target_link_libraries(chgcentre ${CASACORE_LIBRARIES} ${GSL_LIB}
${GSL_CBLAS_LIB} ${MPI_LIBRARIES} ${LAPACK_LIBRARIES})
add_executable(wsuvbinning EXCLUDE_FROM_ALL gridding/examples/wsuvbinning.cpp)
target_link_libraries(wsuvbinning PRIVATE wsclean-lib ${ALL_LIBRARIES})
add_executable(
wspredictionexample EXCLUDE_FROM_ALL gridding/examples/wspredictionexample.cpp
gridding/wstackinggridder.cpp)
target_link_libraries(wspredictionexample ${ALL_LIBRARIES})
install(TARGETS wsclean DESTINATION bin)
install(TARGETS wsclean-lib DESTINATION lib)
install(TARGETS chgcentre DESTINATION bin)
install(FILES interface/wscleaninterface.h DESTINATION include)
# Installing the radler library to ${CMAKE_INSTALL_FULL_LIBDIR}
# ensures that users do not manually have to set the LD_LIBRARY_PATH
install(FILES ${RADLER_LIB} DESTINATION ${CMAKE_INSTALL_FULL_LIBDIR})
if(MPI_FOUND)
install(TARGETS wsclean-mp DESTINATION bin)
endif(MPI_FOUND)
add_custom_target(
sphinxdoc
make html
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc
COMMENT "Generating documentation with Sphinx"
VERBATIM)
# add target to generate API documentation with Doxygen
find_package(Doxygen)
if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(
doxygendoc
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen"
VERBATIM)
add_custom_target(doc DEPENDS doxygendoc sphinxdoc)
else(DOXYGEN_FOUND)
message(STATUS "Doxygen not found: API documentation can not compiled.")
add_custom_target(doc DEPENDS sphinxdoc)
endif(DOXYGEN_FOUND)
if(BUILD_TESTING)
# Boost 1.59 introduced BOOST_TEST, which several tests use.
find_package(Boost 1.59.0 COMPONENTS unit_test_framework)
if(Boost_FOUND)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
add_subdirectory(tests)
else()
message(
STATUS
"Boost testing framework not found (not required for wsclean: only required for running tests)."
)
endif()
endif()
get_directory_property(MAIN_COMPILE_OPTIONS COMPILE_OPTIONS)
string(REPLACE ";" " " MAIN_COMPILE_OPTIONS "${MAIN_COMPILE_OPTIONS}")
message(STATUS "Flags passed to C++ compiler: ${MAIN_COMPILE_OPTIONS}")