Merge pull request #189 from vais-ral/fix-conda-build

Author: casperdcl

CMakeLists.txt

@@ -8,19 +8,6 @@ if(NOT CMAKE_BUILD_TYPE)
 endif()
 message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 
-# The version number.
-set (RGL_VERSION_MAJOR 1)
-set (RGL_VERSION_MINOR 0)
-
-set (CIL_VERSION_MAJOR 0)
-set (CIL_VERSION_MINOR 10)
-set (CIL_VERSION_PATCH 2)
-
-# set (CIL_VERSION '${CIL_VERSION_MAJOR}.${CIL_VERSION_MINOR}.${CIL_VERSION_PATCH}' CACHE INTERNAL "Core Imaging Library version" FORCE)
-# get CIL_VERSION from environment variable and set it in cmake
-set (CIL_VERSION $ENV{CIL_VERSION} CACHE INTERNAL "Core Imaging Library version" FORCE)
-message(STATUS "CIL_VERSION: ${CIL_VERSION}")
-
 # set the Python variables for the Conda environment
 #include(${CMAKE_SOURCE_DIR}/CMake/FindAnacondaEnvironment.cmake)
 

Installation.md

@@ -40,6 +40,7 @@ git clone https://github.com/vais-ral/CCPi-Regularisation-Toolkit
 cd CCPi-Regularisation-Toolkit
 cmake -S . -B ./build_proj -DBUILD_MATLAB_WRAPPER=ON -DBUILD_PYTHON_WRAPPER=ON -DBUILD_CUDA=ON -DCMAKE_INSTALL_PREFIX=./install
 cmake --build ./build_proj --target install
+pip install ./src/Python
 ```
 
 ### Python
@@ -55,11 +56,9 @@ conda install ccpi-regulariser -c ccpi -c conda-forge
 #### Python (conda-build)
 
 ```sh
-export CIL_VERSION=$(date +%Y.%m.%d) # UNIX
-# set CIL_VERSION=24.3.0             # Windows
 conda build recipe/ --numpy 1.23 --python 3.10
-conda install ccpi-regulariser=${CIL_VERSION} --use-local --force-reinstall # doesn't work?
-conda install -c file://${CONDA_PREFIX}/conda-bld/ ccpi-regulariser=${CIL_VERSION} --force-reinstall # try this one
+conda install ccpi-regulariser --use-local --force-reinstall # doesn't work?
+conda install -c file://${CONDA_PREFIX}/conda-bld/ ccpi-regulariser --force-reinstall # try this one
 cd demos/
 python demo_cpu_regularisers.py # to run CPU demo
 python demo_gpu_regularisers.py # to run GPU demo
@@ -81,7 +80,7 @@ pip install git+https://github.com/vais-ral/CCPi-Regularisation-Toolkit
 If passed `BUILD_PYTHON_WRAPPER=ON`, CMake will install libraries in-place under `./src/Python`, followed by running `python -m pip install ./src/Python`.
 (Note that libraries are also installed under the user-specified `${CMAKE_INSTALL_PREFIX}`, which could be set to a throwaway directory, e.g. `-DCMAKE_INSTALL_PREFIX=./install`).
 
-If Python is not picked by CMake you can provide the additional flag to CMake `-DPYTHON_EXECUTABLE=/path/to/executable/python`.
+If Python is not found by CMake you can provide the additional flag to CMake `-DPYTHON_EXECUTABLE=/path/to/executable/python`.
 
 Tests can also be run in-place after the build:
 

build/run.sh

@@ -6,7 +6,6 @@ rm -r ../build_proj
 mkdir ../build_proj
 cd ../build_proj/
 #make clean
-export CIL_VERSION=23.04.1
 # install Python modules without CUDA
 #cmake ../ -DBUILD_PYTHON_WRAPPER=ON -DBUILD_MATLAB_WRAPPER=OFF -DBUILD_CUDA=OFF -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./install
 # install Python modules with CUDA

recipe/bld.bat

@@ -1,14 +1,13 @@
-IF NOT DEFINED CIL_VERSION (
-ECHO CIL_VERSION Not Defined.
-exit 1
-)
-
-mkdir "%SRC_DIR%\test"
-ROBOCOPY /E "%RECIPE_DIR%\..\test" "%SRC_DIR%\test"
-cd %SRC_DIR%
-
-:: issue cmake to create setup.py
-cmake -G "NMake Makefiles" %RECIPE_DIR%\..\ -DBUILD_PYTHON_WRAPPERS=ON -DCONDA_BUILD=ON -DBUILD_CUDA=ON -DCMAKE_BUILD_TYPE="Release" -DLIBRARY_LIB="%CONDA_PREFIX%\lib" -DLIBRARY_INC="%CONDA_PREFIX%" -DCMAKE_INSTALL_PREFIX="%PREFIX%\Library" 
-
-nmake install
-if errorlevel 1 exit 1
+mkdir "%SRC_DIR%\test"
+ROBOCOPY /E "%RECIPE_DIR%\..\test" "%SRC_DIR%\test"
+if exist "%RECIPE_DIR%\..\build_proj" (
+    rd /s /q "%RECIPE_DIR%\..\build_proj"
+)
+
+:: add -G "Visual Studio 16 2019" to the cmake command to specify the generator
+:: add -DCUDA_TOOLKIT_ROOT_DIR="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v12.4" to the cmake command to specify the CUDA toolkit
+cmake -S "%SRC_DIR%" -B "%RECIPE_DIR%\..\build_proj" -DBUILD_PYTHON_WRAPPERS=ON -DCONDA_BUILD=ON -DBUILD_CUDA=ON -DCMAKE_BUILD_TYPE="RelWithDebInfo" -DLIBRARY_INC="%CONDA_PREFIX%" -DCMAKE_INSTALL_PREFIX="%RECIPE_DIR%\..\install"
+cmake --build "%RECIPE_DIR%\..\build_proj" --target install --config RelWithDebInfo
+%PYTHON% -m pip install "%SRC_DIR%\src\Python"
+
+if errorlevel 1 exit 1

recipe/build.sh

@@ -1,8 +1,6 @@
-set -xe 
+set -xe
 cp -rv "$RECIPE_DIR/../test" "$SRC_DIR/"
 
-cd $SRC_DIR
-
-cmake -G "Unix Makefiles" $RECIPE_DIR/../ -DBUILD_PYTHON_WRAPPER=ON -DCONDA_BUILD=ON -DBUILD_CUDA=ON -DCMAKE_BUILD_TYPE="Release" -DLIBRARY_LIB=$CONDA_PREFIX/lib -DLIBRARY_INC=$CONDA_PREFIX -DCMAKE_INSTALL_PREFIX=$PREFIX
-
-make install
+cmake -S "$SRC_DIR" -B "$RECIPE_DIR/../build_proj" -DBUILD_PYTHON_WRAPPER=ON -DCONDA_BUILD=ON -DBUILD_CUDA=ON -DCMAKE_BUILD_TYPE="RelWithDebInfo" -DLIBRARY_INC=$CONDA_PREFIX -DCMAKE_INSTALL_PREFIX="$RECIPE_DIR/../install"
+cmake --build "$RECIPE_DIR/../build_proj" --target install
+$PYTHON -m pip install "$SRC_DIR/src/Python"

recipe/meta.yaml

@@ -1,12 +1,13 @@
+# https://docs.conda.io/projects/conda-build/en/stable/resources/define-metadata.html#loading-data-from-other-files
+# TODO: use scikit-build-core & setuptools_scm instead
+{% set project = load_file_data('../src/Python/pyproject.toml', from_recipe_dir=True).get('project', {}) %}
 package:
-  name: ccpi-regulariser
-  version: {{ environ.get('GIT_DESCRIBE_TAG','v')[1:] }}
+  name: {{ project.get('name') }}
+  version: {{ project.get('version') }}
 
 build:
   preserve_egg_dir: False
   number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }}
-  script_env:
-    - CIL_VERSION
 
 source:
   path: ..
@@ -25,7 +26,7 @@ requirements:
     - pip
     - vc 14 # [win]
     - cmake
-    - ripgrep 
+    - ripgrep
 
   run:
     - {{ pin_compatible('numpy', min_pin='x.x', max_pin='x.x') }}
@@ -34,6 +35,6 @@ requirements:
     - libgcc-ng # [unix]
 
 about:
-  home: http://www.ccpi.ac.uk
-  license:  BSD license
-  summary: 'CCPi Core Imaging Library Quantification Toolbox'
+  home: https://tomographicimaging.github.io/CIL/
+  license:  Apache-2.0
+  summary: 'The set of CPU/GPU optimised regularisation modules for iterative image reconstruction and other image processing tasks'

src/Core/CMakeLists.txt

@@ -63,7 +63,9 @@ endif()
 if (BUILD_CUDA)
     find_package(CUDA)
     if (CUDA_FOUND)
-      set(CUDA_NVCC_FLAGS "-Xcompiler -fPIC -shared -D_FORCE_INLINES")
+      if (UNIX)
+        set(CUDA_NVCC_FLAGS "-Xcompiler -fPIC -shared -D_FORCE_INLINES")
+      endif()
       message(STATUS "CUDA_NVCC_FLAGS: ${CUDA_NVCC_FLAGS}")
       CUDA_ADD_LIBRARY(cilregcuda SHARED
         ${CMAKE_CURRENT_SOURCE_DIR}/regularisers_GPU/TV_ROF_GPU_core.cu

src/Python/CMakeLists.txt

@@ -3,22 +3,20 @@ project(regulariserPython)
 message(STATUS "Creating Python Wrapper")
 #include (GenerateExportHeader)
 
+cmake_policy(SET CMP0094 NEW)
+set(Python_FIND_REGISTRY LAST) # prefer active over base conda env
+set(Python_FIND_VIRTUALENV STANDARD) # use PATH to search
 find_package(Python COMPONENTS Interpreter REQUIRED)
 
 set(PIP_CMAKE_DEPS cilreg)
 if(TARGET cilregcuda)
   list(APPEND PIP_CMAKE_DEPS cilregcuda)
 endif()
-if (UNIX)
-  install(TARGETS ${PIP_CMAKE_DEPS}
-	  LIBRARY DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/ccpi/filters"
-	  CONFIGURATIONS ${CMAKE_BUILD_TYPE})
-elseif(WIN32)
-  install(TARGETS ${PIP_CMAKE_DEPS}
-	  RUNTIME DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/ccpi/filters"
-	  ARCHIVE DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/ccpi/filters"
-	  CONFIGURATIONS ${CMAKE_BUILD_TYPE})
-endif()
+install(TARGETS ${PIP_CMAKE_DEPS}
+  LIBRARY DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/ccpi/filters"
+  RUNTIME DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/ccpi/filters"
+  ARCHIVE DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/ccpi/filters"
+  CONFIGURATIONS ${CMAKE_BUILD_TYPE})
 
 add_custom_target(PythonWrapper ALL
   COMMAND "${Python_EXECUTABLE}" -m pip install "${CMAKE_CURRENT_SOURCE_DIR}" --verbose

src/Python/ccpi/filters/TV.py

@@ -471,6 +471,8 @@ def TV_ENERGY(U, U0, lambdaPar, type, E_val=None):
 TGV_GPU = None
 dTV_FGP_GPU = None
 
+PatchSelect_GPU = None
+
 if cilregcuda is not None:
     def TV_ROF_GPU(inputData, regularisation_parameter, iterationsNumb, 
                 marching_step_parameter, tolerance_param, gpu_device, out=None, infovector=None):

src/Python/ccpi/filters/utils.py

@@ -1,31 +1,23 @@
 import platform
 import ctypes
 import os
+import warnings
 
-if platform.system() == 'Linux':
-    dll = 'libcilreg.so'
-elif platform.system() == 'Windows':
-    dll_file = 'cilreg.dll'
-    dll = ctypes.util.find_library(dll_file)
-elif platform.system() == 'Darwin':
-    dll = 'libcilreg.dylib'
+try:
+    pre = {'Linux': 'lib', 'Windows': '', 'Darwin': 'lib'}[platform.system()]
+except KeyError:
+    raise ValueError(f"unsupported platform: {platform.system()}")
 else:
-    raise ValueError('Not supported platform, ', platform.system())
+    ext = {'Linux': '.so', 'Windows': '.dll', 'Darwin': '.dylib'}[platform.system()]
 
-cilreg = ctypes.cdll.LoadLibrary(os.path.join(os.path.dirname(__file__), dll))
+_here = os.path.dirname(__file__)
+dll = f'{pre}cilreg{ext}'
+cilreg = ctypes.cdll.LoadLibrary(os.path.join(_here, dll))
 
+gpudll = f'{pre}cilregcuda{ext}'
 try:
-    if platform.system() == 'Linux':
-        gpudll = 'libcilregcuda.so'
-    elif platform.system() == 'Windows':
-        gpudll_file = 'cilregcuda.dll'
-        gpudll = ctypes.util.find_library(gpudll_file)
-    elif platform.system() == 'Darwin':
-        gpudll = 'libcilregcuda.dylib'
-    else:
-        raise ValueError('Not supported platform, ', platform.system())
-
-    cilregcuda = ctypes.cdll.LoadLibrary(os.path.join(os.path.dirname(__file__), gpudll))
-except OSError as ose:
-    print(ose)
+    cilregcuda = ctypes.cdll.LoadLibrary(os.path.join(_here, gpudll))
+except Exception as exc:
+    warnings.warn(str(exc), ImportWarning, stacklevel=2)
+    warnings.warn(f"Found: {os.listdir(_here)}", ImportWarning, stacklevel=2)
     cilregcuda = None

src/Python/pyproject.toml

@@ -8,4 +8,4 @@ include = ["ccpi", "ccpi.*"]
 
 [project]
 version = "24.0.0"
-name='ccpi-regularisers'
+name = "ccpi-regulariser"