fix for mkl_spblas.mod and doxygen doc is now Fortran specific

Author: Jared Frazier

CMakeLists.txt

@@ -4,12 +4,12 @@ option(BUILD_SHARED_LIBS "Build shared libraries" ON)
 option(BUILD_TESTING "Build tests" OFF)
 
 option(ENABLE_SPBLAS "Build with SPBLAS" ON)
+option(ENABLE_FIND_INTEL_MKL "Find intel MKL config" OFF)
 
 option(ENABLE_FFTPACK "Build with fftpack" OFF)
 option(ENABLE_PFUNIT "Build with pFUnit" OFF)
 option(ENABLE_TEST_DRIVE "Build with test-drive" OFF)
 
-
 project(
     HelloSPBLAS 
     VERSION 0.1.0 
@@ -19,7 +19,12 @@ project(
 
 # Set paths to Intel oneAPI MKL
 if(${ENABLE_SPBLAS})
-    #find_package(MKL CONFIG)
+    if (${ENABLE_FIND_INTEL_MKL})
+        find_package(MKL CONFIG)
+        get_target_property(MKLINCLUDE MKL::MKL INTERFACE_INCLUDE_DIRECTORIES)
+    endif()
+   
+    # manually set MKL vars  
     if (NOT MKL_FOUND)
         message(STATUS "Did not find MKL, trying to use env vars/user input")
         set(MKLROOT $ENV{MKLROOT} CACHE PATH "Installation directory of Intel MKL")
@@ -31,6 +36,33 @@ if(${ENABLE_SPBLAS})
     else()
         message(STATUS "Found MKL")
     endif()
+
+    if(NOT EXISTS "${MKLINCLUDE}/mkl_spblas.mod")
+        set(NO_MKL_SPBLAS_MOD "
+        =======================================================================
+            ${MKLINCLUDE} does not contain mkl_spblas.mod
+            If you installed Intel MKL to a directory 
+            that requires root permissions,
+            (e.g., /opt/intel/oneapi/mkl/latest/)
+            ```
+            # alternatively... you could update secure path in sudo visudo
+            sudo -i
+            echo 'source /opt/intel/oneapi/setvars.sh > /dev/null' >> ~/.bashrc
+            source ~/.bashrc
+            your_mkl_include=/opt/intel/oneapi/mkl/latest/include
+            ifx -c your_mkl_include/mkl_spblas.f90
+            ```
+            otherwise if you installed to a directory
+            that does not require root permissions, it 
+            should be sufficient to call
+            ```
+            cd /your/mkl/include # replace with your local path
+            ifx -c mkl_spblas.f90
+            ```
+        =======================================================================
+        ")
+        message(FATAL_ERROR "${NO_MKL_SPBLAS_MOD}")
+    endif()
 endif()
 
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${PROJECT_SOURCE_DIR}/cmake")

README.md

@@ -8,6 +8,11 @@ Can easily use `pFUnit` or `test-drive` for unit testing.
 
 Make sure you have the [Intel oneAPI HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit-download.html?packages=hpc-toolkit&hpc-toolkit-os=linux&hpc-toolkit-lin=apt) or [Intel Fortran Essentials](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit-download.html?packages=fortran-essentials&fortran-essentials-os=linux&fortran-essentials-lin=apt).
 
+Make sure also that in your `${MKLROOT}/include` directory there is a file
+called `mkl_spblas.mod`. The most up to date version of Intel MKL does not 
+ship with `mkl_spblas.mod` by default, so you have to compile it separately
+via `ifx -c /path/to/mkl_spblas.f90`.
+ 
 Then, you can configure, build, and run tests for the project. 
 
 ```shell 

cmake/helper.cmake

@@ -6,7 +6,6 @@
 # modified from fftpack
 
 function(link_spblas targ)
-    # 
     if (MKL_FOUND)
         # https://www.intel.com/content/www/us/en/docs/onemkl/developer-guide-macos/2023-0/cmake-config-for-onemkl.html
         target_compile_options(
@@ -19,7 +18,7 @@ function(link_spblas targ)
         # Add include directories
         target_include_directories(
             ${targ}
-            PUBLIC ${MKLINCLUDE}/intel64/ilp64/
+            PUBLIC ${MKLINCLUDE}
         )
 
         # Specify the MKL libraries for linking

config/intel_ubuntu_spblas

@@ -3,7 +3,11 @@
 #   where buildodcs is any nonempty string to trigger doc build
 builddocs=$1
 [[ -d build-spblas ]] && rm -rf build-spblas 
-cmake -S . -B build-spblas -DCMAKE_Fortran_COMPILER=ifx -DBUILD_TESTING=ON
+cmake -S . -B build-spblas\
+    -DCMAKE_Fortran_COMPILER=ifx\
+    -DBUILD_TESTING=ON\
+    -DENABLE_SPBLAS=ON\
+    -DENABLE_FIND_INTEL_MKL=ON
 cmake --build build-spblas
 ./build-spblas/test/test_spblas 
 [[ -n $builddocs ]] && cmake --build build-spblas --target doxygen_docs 

src/CMakeLists.txt

@@ -13,6 +13,7 @@ if(NOT EXISTS ${Fortran_MODULE_DIRECTORY})
     file(MAKE_DIRECTORY "${Fortran_MODULE_DIRECTORY}")
 endif()
 
+# Add my library
 add_library(${PROJECT_NAME} ${HelloSPBLAS_SOURCES})
 set_target_properties(
     ${PROJECT_NAME}
@@ -37,6 +38,8 @@ if(${ENABLE_SPBLAS})
     link_spblas(${PROJECT_NAME})    
 endif()
 
+
+
 # installation/configuration steps (modified from fotran-lang/stdlib)
 install(
     TARGETS ${PROJECT_NAME}

src/mo_square.f90

@@ -1,9 +1,5 @@
 !> @file mo_square.f90 
 !! @brief Defines a module of simple mathematical operations.
-!! @todo remove the ifdef include statement since this throws off doxygen
-!#ifdef INTEL_SPBLAS 
-!INCLUDE "mkl_spblas.f90"
-!#endif
 MODULE mo_square
 
 #ifdef FFTPACK