Prepare for conan package

.github/workflows/conan.yml

@@ -0,0 +1,41 @@
+name: Run conan
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+    branches: 
+      - master
+      - main
+  workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }} 
+    cancel-in-progress: true
+
+
+jobs:
+    conan:
+        strategy:
+          matrix:
+            os: [ ubuntu-latest, windows-latest, macos-latest] 
+        runs-on: ${{matrix.os}}
+        if: "!contains(github.event.head_commit.message, 'skip-ci')"
+
+        steps:
+          - uses: actions/checkout@v4
+            with:
+              persist-credentials: false
+          - uses: actions/setup-python@v5
+            with:
+              python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+              architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+          - name: Install conan
+            run: pip install conan>2
+          - run: conan profile detect
+          - run: conan create . --build=missing --options shared=True
+            name: Build shared
+          - run: conan create . --build=missing --options shared=False
+            name: Build static

.github/workflows/test-mac.yml

@@ -0,0 +1,32 @@
+name: Mac unit tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  mac-tests:
+    runs-on: macos-latest
+    if: "!contains(github.event.head_commit.message, 'skip-ci')"
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+          persist-credentials: false
+    - name : installPackages
+      run : brew install eigen boost boost-python3 libomp gflags
+    - name : install python packages
+      run: pip3 install numpy setuptools --break-system-packages
+    - name: Get number of CPU cores
+      uses: SimenB/github-actions-cpu-cores@v1
+      id: cpu-cores
+    - name: cmake
+      run: mkdir build && cd build && cmake .. -DLIBCMAES_BUILD_PYTHON=On -DLIBCMAES_BUILD_TESTS=On -DLIBCMAES_USE_OPENMP=On
+    - name: compile
+      run: cd build && cmake --build . -j${{ steps.cpu-cores.outputs.count }}
+    - name: Run ctest
+      run: cd build && ctest -j${{ steps.cpu-cores.outputs.count }} --output-on-failure
+

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Ubuntu unit tests
+
+on:
+  push:
+    branches: [ master]
+  pull_request:
+    branches: [ master, develop ]
+  workflow_dispatch:
+
+
+jobs:
+  ubuntu-tests-fullSetup:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'skip-ci')"
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+          persist-credentials: false
+    - name : installPackages
+      run : sudo apt-get update && sudo apt-get install --no-install-recommends --yes libeigen3-dev libboost-all-dev libgflags-dev
+    - name : install python packages
+      run: pip3 install numpy
+    - name: Get number of CPU cores
+      uses: SimenB/github-actions-cpu-cores@v1
+      id: cpu-cores
+    - name: cmake
+      run: mkdir build && cd build && cmake .. -DLIBCMAES_BUILD_PYTHON=On -DLIBCMAES_BUILD_TESTS=On -DLIBCMAES_USE_OPENMP=On
+    - name: compile
+      run: cd build && cmake --build . -j${{ steps.cpu-cores.outputs.count }}
+    - name: Run ctest
+      run: cd build && ctest -j${{ steps.cpu-cores.outputs.count }} --output-on-failure
+
+

.gitignore

@@ -0,0 +1,8 @@
+build/
+CMakeLists.txt.user
+CMakeUserPresets.json
+install/
+installFolder/
+conandummy/
+test_package/CMakeUserPresets.json
+lib/

CMakeLists.txt

@@ -1,20 +1,21 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.15)
+
+set(libcmaes_VERSION 0.10.1)
 
 project (libcmaes
-  VERSION 0.10
+  VERSION ${libcmaes_VERSION}
   LANGUAGES C CXX
   DESCRIPTION "A C++11 library for stochastic optimization with CMA-ES")
 
 if (NOT DEFINED CMAKE_BUILD_TYPE)
   set (CMAKE_BUILD_TYPE Release CACHE STRING "Build type")
 endif ()
 
-set(CMAKE_CXX_FLAGS "-Wall -Wextra")
-set(CMAKE_CXX_FLAGS_DEBUG "-g")
-set(CMAKE_CXX_FLAGS_RELEASE "-O3")
-
+list (APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 list (APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
 
+include(CompilerOptions)
+
 set (LIBCMAES_TOP_LEVEL NO)
 if (${PROJECT_SOURCE_DIR} STREQUAL ${CMAKE_SOURCE_DIR})
   set (LIBCMAES_TOP_LEVEL YES)
@@ -66,7 +67,19 @@ check_include_file (sys/types.h HAVE_SYS_TYPES_H)
 check_include_file (sys/stat.h HAVE_SYS_STAT_H)
 
 # ---------- dependencies ----------
-find_package (Eigen3 3.0.0 REQUIRED)
+if(LIBCMAES_BUILD_PYTHON)
+  find_package (Python3 COMPONENTS Interpreter Development NumPy)
+  if (NOT TARGET Python3::Module AND Python3_Development_FOUND)
+    add_library (Python3::Module SHARED IMPORTED)
+    set_target_properties (
+      Python3::Module
+      PROPERTIES IMPORTED_LOCATION ${Python3_LIBRARIES}
+                  INTERFACE_INCLUDE_DIRECTORIES ${Python3_INCLUDE_DIRS})
+  endif ()
+endif()
+
+
+find_package (Eigen3 3.4.0 REQUIRED)
 
 if (LIBCMAES_USE_OPENMP)
   find_package (OpenMP QUIET)
@@ -77,24 +90,21 @@ if (LIBCMAES_USE_OPENMP)
 endif ()
 
 if (LIBCMAES_BUILD_PYTHON)
-  find_package (PythonInterp)
-  find_package (PythonLibs)
-  if (NOT TARGET Python::Module AND PYTHONLIBS_FOUND)
-    add_library (Python::Module SHARED IMPORTED)
+  find_package (Python3 COMPONENTS Interpreter Development NumPy)
+  if (NOT TARGET Python3::Module AND Python3_Development_FOUND)
+    add_library (Python3::Module SHARED IMPORTED)
     set_target_properties (
-      Python::Module
-      PROPERTIES IMPORTED_LOCATION ${PYTHON_LIBRARIES}
-                 INTERFACE_INCLUDE_DIRECTORIES ${PYTHON_INCLUDE_DIRS})
+      Python3::Module
+      PROPERTIES IMPORTED_LOCATION ${Python3_LIBRARIES}
+                 INTERFACE_INCLUDE_DIRECTORIES ${Python3_INCLUDE_DIRS})
   endif ()
 
-  find_package (NumPy)
-
   # python site dir
-  if (PYTHON_EXECUTABLE AND NOT DEFINED PYTHON_SITE_PACKAGES)
+  if (Python3_EXECUTABLE AND NOT DEFINED PYTHON_SITE_PACKAGES)
     # $ENV{VIRTUAL_ENV} does not work because not exported by activate :/
     execute_process (
       COMMAND
-        ${PYTHON_EXECUTABLE} -c "
+        ${Python3_EXECUTABLE} -c "
 import sys;
 if 'real_prefix' in dir(sys):
     print(sys.prefix)"
@@ -107,7 +117,7 @@ if 'real_prefix' in dir(sys):
     endif ()
     execute_process (
       COMMAND
-        ${PYTHON_EXECUTABLE} -c
+        ${Python3_EXECUTABLE} -c
         "from distutils import sysconfig; print(sysconfig.get_python_lib(plat_specific=True, prefix='${SITE_DIR_PREFIX}'))"
       OUTPUT_VARIABLE _ABS_PYTHON_SITE_PACKAGES
       RESULT_VARIABLE _exit_code
@@ -120,7 +130,7 @@ if 'real_prefix' in dir(sys):
             ${_ABS_PYTHON_SITE_PACKAGES})
       set (PYTHON_SITE_PACKAGES ${_REL_PYTHON_SITE_PACKAGES})
     else ()
-      message (SEND_ERROR "Could not run ${PYTHON_EXECUTABLE}")
+      message (SEND_ERROR "Could not run ${Python3_EXECUTABLE}")
     endif ()
   endif ()
 
@@ -161,42 +171,49 @@ if (LIBCMAES_BUILD_EXAMPLES)
   add_subdirectory (examples)
 endif ()
 if (LIBCMAES_BUILD_TESTS)
-  enable_testing ()
+  include(CTest)
   add_subdirectory (tests)
 endif ()
 
-if (Boost_FOUND AND NumPy_FOUND)
+if (Boost_FOUND AND Python3_NumPy_FOUND)
   add_subdirectory (python)
 endif ()
 
 # ------------ export ------------
 add_library (libcmaes::cmaes ALIAS cmaes)
 
 include (CMakePackageConfigHelpers)
-write_basic_package_version_file (
-  libcmaesConfigVersion.cmake VERSION ${PACKAGE_VERSION}
-  COMPATIBILITY AnyNewerVersion)
+write_basic_package_version_file(
+    libcmaes-config-version.cmake
+    VERSION ${PACKAGE_VERSION}
+    COMPATIBILITY AnyNewerVersion)
+
+
+
+configure_package_config_file(
+  libcmaes-config.cmake.in
+  libcmaes-config.cmake
+  INSTALL_DESTINATION ${RELATIVE_INSTALL_CMAKE_DIR})
 
 # export target to build directory
 export (TARGETS cmaes NAMESPACE libcmaes:: FILE libcmaesTargets.cmake)
+
 # export target on install
 install (
   EXPORT libcmaesTargets
   FILE libcmaesTargets.cmake
   NAMESPACE libcmaes::
   DESTINATION ${RELATIVE_INSTALL_CMAKE_DIR})
 
-configure_file (libcmaesConfig.cmake.in libcmaesConfig.cmake @ONLY)
 install (
-  FILES "${CMAKE_CURRENT_BINARY_DIR}/libcmaesConfig.cmake"
-        "${CMAKE_CURRENT_BINARY_DIR}/libcmaesConfigVersion.cmake"
-        "${CMAKE_CURRENT_SOURCE_DIR}/cmake/FindEigen3.cmake"
+  FILES "${CMAKE_CURRENT_BINARY_DIR}/libcmaes-config.cmake"
+        "${CMAKE_CURRENT_BINARY_DIR}/libcmaes-config-version.cmake"
   DESTINATION ${RELATIVE_INSTALL_CMAKE_DIR})
 
 # ------------------------ Doxygen --------------------------------------------
 
 find_package(Doxygen)
-if(DOXYGEN_FOUND)
+if(DOXYGEN_FOUND AND LIBCMAES_TOP_LEVEL)
 
   set(DOXYGEN_USE_MATHJAX YES)
   set(DOXYGEN_STRIP_FROM_INC_PATH "${CMAKE_CURRENT_SOURCE_DIR}/include")
@@ -213,6 +230,6 @@ if(DOXYGEN_FOUND)
                      "${CMAKE_CURRENT_SOURCE_DIR}/src/"
                      "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
 
-else (DOXYGEN_FOUND)
+else ()
   message("Doxygen need to be installed to generate the doxygen documentation")
-endif(DOXYGEN_FOUND)
+endif()

README.md

@@ -1,6 +1,6 @@
 ## libcmaes
 
-[![Doxygen](https://img.shields.io/badge/Documentation-Doxygen-success)](https://beniz.github.io/libcmaes/doc/html/index.html)
+[![Doxygen](https://img.shields.io/badge/Documentation-Doxygen-success)](https://cma-es.github.io/libcmaes/doc/html/index.html)
 
 libcmaes is a multithreaded C++11 implementation (with Python bindings) of algorithms of the CMA-ES family for optimization of nonlinear non-convex 'blackbox' functions. The implemented algorithms have a wide range of applications in various disciplines, ranging from pure function minimization, optimization in industrial and scientific applications, to the solving of reinforcement and machine learning problems.
 
@@ -26,7 +26,7 @@ Current features include:
 Documentation:
 
 - Full documentation is available from https://github.com/beniz/libcmaes/wiki
-- API documentation is available from http://beniz.github.io/libcmaes/doc/html/index.html
+- API documentation is available from https://cma-es.github.io/libcmaes/doc/html/index.html
 
 Dependencies: