Merge pull request #2591 from ERGO-Code/hipo-dev

BLAS order, default, printing out of blas libraries from HiGHS, docs update

Author: galabovaa

cmake/FindHipoDeps.cmake

@@ -1,11 +1,11 @@
 # BLAS
-set(USE_CMAKE_FIND_BLAS ON)
-
 set(BLAS_ROOT "" CACHE STRING "Root directory of BLAS or OpenBLAS")
-if (NOT (BLAS_ROOT STREQUAL ""))
+if (NOT BLAS_ROOT STREQUAL "")
     message(STATUS "BLAS_ROOT is " ${BLAS_ROOT})
 endif()
 
+set(USE_CMAKE_FIND_BLAS ON)
+
 # Optionally set the vendor:
 # set(BLA_VENDOR libblastrampoline)
 
@@ -100,12 +100,39 @@ if (NOT USE_CMAKE_FIND_BLAS)
         endif()
     endif()
 else()
-    find_package(BLAS REQUIRED)
-    if (BLAS_FOUND)
-        message(STATUS "Using BLAS library: ${BLAS_LIBRARIES}")
-        message(STATUS "BLAS include dirs: ${BLAS_INCLUDE_DIRS}")
+
+    if (NOT BLA_VENDOR)
+        if (APPLE)
+            set (BLA_VENDOR Apple)
+        elseif(LINUX)
+            set (BLA_VENDOR OpenBLAS)
+        elseif(WIN32)
+            set (BLA_VENDOR OpenBLAS)
+        endif()
+
+        find_package(BLAS QUIET)
+        if (BLAS_FOUND)
+            message(STATUS "Using BLAS library: ${BLAS_LIBRARIES}")
+            if (BLAS_INCLUDE_DIRS)
+                message(STATUS "BLAS include dirs: ${BLAS_INCLUDE_DIRS}")
+            endif()
+        else()
+            unset(BLA_VENDOR)
+        endif()
     else()
-        message(FATAL_ERROR "No BLAS library found!")
+        message(STATUS "Specified BLA_VENDOR: ${BLA_VENDOR}")
+    endif()
+
+    if (NOT BLAS_FOUND)
+        find_package(BLAS REQUIRED)
+        if (BLAS_FOUND)
+            message(STATUS "Using BLAS library: ${BLAS_LIBRARIES}")
+            if (BLAS_INCLUDE_DIRS)
+                message(STATUS "BLAS include dirs: ${BLAS_INCLUDE_DIRS}")
+            endif()
+        else()
+            message(FATAL_ERROR "No BLAS library found!")
+        endif()
     endif()
 endif()
 

docs/src/installation.md

@@ -1,6 +1,6 @@
 # Install HiGHS
 
-## Compile from source 
+## Compile from source
 
 HiGHS uses CMake as build system, and requires at least version
 3.15. Details about building from source using CMake can be found in `HiGHS/cmake/README.md`.
@@ -11,62 +11,64 @@ HiGHS does not have any external dependencies, however, the new interior point s
 
 #### BLAS
 
-On Linux, libblas and libopenblas are supported. We recomment libopenblas for its better performance. Install with 
+On Linux, libblas and libopenblas are supported. We recomment libopenblas for its better performance, and it is found by default if available on the system. Install with
 
 ```
 sudo apt update
 sudo apt install libopenblas-dev
 ```
 
-On MacOS no BLAS installation is required because HiPO uses [Apple Accelerate](https://developer.apple.com/accelerate/).
+On MacOS no BLAS installation is required because HiPO uses [Apple Accelerate](https://developer.apple.com/accelerate/) by default.
 
-On Windows, OpenBLAS is required. It could be installed via [vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/overview) with 
+On Windows, OpenBLAS is required. It could be installed via [vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/overview) with
 
 ```
 vcpkg install openblas[threads]
 ```
 Note, that `[threads]` is required for HiPO.
 
+To specify explicitly which BLAS vendor to look for, `BLA_VENDOR` coud be set in CMake, e.g. `-DBLA_VENDOR=Apple` or `-DBLA_VENDOR=OpenBLAS`. Alternatively, to specify which BLAS library to use, set `BLAS_LIBRARIES` to the full path of the library e.g. `-DBLAS_LIBRARIES=/path_to/libopenblas.so`.
+
 #### Metis
-There are some known issues with Metis so the recommented version is in [this fork](https://github.com/galabovaa/METIS/tree/510-ts), branch 510-ts. This is version 5.10 with several patches for more reliable build and execution. Clone the repository with 
+There are some known issues with Metis so the recommented version is in [this fork](https://github.com/galabovaa/METIS/tree/510-ts), branch 510-ts. This is version 5.10 with several patches for more reliable build and execution. Clone the repository with
 ```
 git clone https://github.com/galabovaa/METIS.git
 cd METIS
 git checkout 510-ts
 ```
 
-Then build with 
+Then build with
 ```
 cmake -S. -B build
 -DGKLIB_PATH=/path_to_METIS_repo/GKlib
--DCMAKE_INSTALL_PREFIX=path_to_installs_dir 
+-DCMAKE_INSTALL_PREFIX=path_to_installs_dir
 cmake --build build
-cmake --install build 
+cmake --install build
 ```
 
-On Windows, do not forget to specify configuration type 
+On Windows, do not forget to specify configuration type
 ```
 cmake --build build --config Release
 ```
 
-### HiPO 
+### HiPO
 
-To install HiPO, on Linux and MacOS, run 
+To install HiPO, on Linux and MacOS, run
 ```
-cmake -S. -B build -DHIPO=ON -DMETIS_ROOT=path_to_installs_dir 
+cmake -S. -B build -DHIPO=ON -DMETIS_ROOT=path_to_installs_dir
 ```
 On Windows, you also need to specify the path to OpenBLAS. If it was installed with vcpkg as suggested above, add the path to `vcpkg.cmake` to the CMake flags, e.g.
 ```
 -DCMAKE_TOOLCHAIN_FILE="C:/vcpkg/scripts/buildsystems/vcpkg.cmake"
 ```
 
-## Bazel build 
+## Bazel build
 
-Alternatively, building with Bazel is supported for Bazel-based projects. To build HiGHS, from the root directory, run 
+Alternatively, building with Bazel is supported for Bazel-based projects. To build HiGHS, from the root directory, run
 
 ```
 bazel build //...
-``` 
+```
 
 ## Install via a package manager
 
@@ -105,7 +107,7 @@ filename.
 
 ## [Building HiGHS with NVidia GPU support](@id gpu-build)
 
-HiGHS must be built, from the root directory, with 
+HiGHS must be built, from the root directory, with
 
 ```
 cmake -S. -Bbuild -DCUPDLP_GPU=ON
@@ -117,21 +119,21 @@ This uses [FindCUDAToolkit](https://cmake.org/cmake/help/latest/module/FindCUDAT
 
 #### Find CUDA
 
-If CUDA is not found automatically, there is an extra option `-DCUPDLP_FIND_CUDA=ON`, to be used with `-DCUPDLP_GPU=ON`, which instead uses `cuPDLP-C`'s `FindCUDAConf.cmake`. 
+If CUDA is not found automatically, there is an extra option `-DCUPDLP_FIND_CUDA=ON`, to be used with `-DCUPDLP_GPU=ON`, which instead uses `cuPDLP-C`'s `FindCUDAConf.cmake`.
 
-This requires the environment variable `CUDA_HOME` to be set to the directory with the CUDA installation. Having set this, run 
+This requires the environment variable `CUDA_HOME` to be set to the directory with the CUDA installation. Having set this, run
 
 ```
 cmake -S. -Bbuild -DCUPDLP_GPU=ON -DCUPDLP_FIND_CUDA=ON
 cmake --build build --parallel
 ```
 
-to build HiGHS. 
+to build HiGHS.
 
 ### Bazel build with Cuda
 
-Alternatively, for Bazel run 
+Alternatively, for Bazel run
 
 ```
 bazel build //... --//:cupdlp_gpu
-``` 
+```

highs/HConfig.h.in

@@ -12,6 +12,7 @@
 #cmakedefine HIGHS_HAVE_MM_PAUSE
 #cmakedefine HIGHS_HAVE_BUILTIN_CLZ
 #cmakedefine HIGHS_HAVE_BITSCAN_REVERSE
+#cmakedefine BLAS_LIBRARIES "@BLAS_LIBRARIES@"
 
 #define HIGHS_GITHASH "@GITHASH@"
 #define HIGHS_VERSION_MAJOR @HIGHS_VERSION_MAJOR@

highs/ipm/hipo/ipm/Solver.cpp

@@ -1421,11 +1421,21 @@ void Solver::printOutput() const {
 void Solver::printInfo() const {
   std::stringstream log_stream;
   log_stream << "\nRunning HiPO\n";
+
+  // Print blas path
+#ifdef BLAS_LIBRARIES
+  log_stream << textline("BLAS:") << BLAS_LIBRARIES << '\n';
+#else
+  log_stream << textline("BLAS:") << "Unknown\n";
+#endif
+
+  // Print number of threads
   if (options_.parallel == kOptionParallelOff)
     log_stream << textline("Threads:") << 1 << '\n';
   else
     log_stream << textline("Threads:") << highs::parallel::num_threads()
                << '\n';
+
   logH_.print(log_stream);
 
   // print information about model