Merge pull request #575 from norlab-ulaval/release

Release 1.4.3 prep
norlab-ulaval · Jun 28, 2024 · c6673ed · c6673ed
2 parents cb16b20 + 0edf664
commit c6673ed
Show file tree

Hide file tree

Showing 64 changed files with 1,827 additions and 1,130 deletions.
diff --git a/.github/workflows/update-API-documentation.yaml b/.github/workflows/update-API-documentation.yaml
@@ -0,0 +1,69 @@
+name: Update Documentation on Website
+
+on:
+  push:
+    branches:
+      - master
+
+
+jobs:
+  build_and_update_docs:
+    runs-on: ubuntu-latest
+    outputs:
+      libnabo_tag: ${{ steps.step1.outputs.libnabo_tag }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y build-essential cmake doxygen graphviz libboost-all-dev libeigen3-dev libyaml-cpp-dev
+
+      - name: Install libnabo 1) install jq
+        run: sudo apt install -y jq  # Install jq for JSON processing
+
+      - name: Install libnabo 2) Get Latest Release Tag
+        id: get_latest_release
+        run: |
+          TAG=$(curl -s https://api.github.com/repos/norlab-ulaval/libnabo/releases/latest | jq -r '.tag_name')
+          echo "::set-output name=tag::$TAG"
+
+      - name: Install libnabo 4) Install libnabo
+        run: |
+          git clone -b ${{ steps.get_latest_release.outputs.tag }} https://github.com/norlab-ulaval/libnabo.git
+          echo "Latest release tag: ${{ steps.get_latest_release.outputs.tag }}"
+          mkdir -p libnabo/build
+          cd libnabo/build
+          cmake ..
+          sudo make install
+
+      - name: Set up libpointmatcher CMake
+        run: |
+          mkdir build
+          cd build
+          cmake -DGENERATE_API_DOC=TRUE ..
+
+      - name: Build Documentation
+        run: cd build && make doc
+
+      - name: Clone website repository
+        uses: actions/checkout@v2
+        with:
+          repository: norlab-ulaval/norlab-ulaval.github.io
+          path: website
+          ssh-key: ${{ secrets.NORLAB_WEBSITE_DOCUMENTATION }}
+          ref: master
+
+      - name: Replace documentation files
+        run: cp -r build/doc/html website/libpointmatcher-doc
+
+      - name: Commit and push changes
+        run: |
+          cd website
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Actions"
+          git add libpointmatcher-doc
+          git commit -m "Update documentation for new release"  || exit 0
+          git push origin HEAD:refs/heads/update-libpointmatcher-docs --force
+
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,6 +5,11 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.12"
+
 # Build documentation with MkDocs
 mkdocs:
   configuration: mkdocs.yml
@@ -15,6 +20,5 @@ mkdocs:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3
   install:
     - requirements: doc/requirements.txt
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -340,8 +340,10 @@ set(POINTMATCHER_SRC
 	pointmatcher/DataPointsFilters/DistanceLimit.cpp
 	pointmatcher/DataPointsFilters/RemoveSensorBias.cpp
 	pointmatcher/DataPointsFilters/Sphericality.cpp
-	pointmatcher/DataPointsFilters/Saliency.cpp
+	pointmatcher/DataPointsFilters/Saliency.cpp	
 	pointmatcher/DataPointsFilters/SpectralDecomposition.cpp
+#PointCloudGenerators
+	pointmatcher/PointCloudGenerator.cpp
 )
 
 

diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ on your workstation to speed up your local development workflow.
 [//]: # (====Body=================================================================================)
 # Documentation and Tutorials
 
-**Quick link for the tutorial pages: [Tutorials](doc/index.md)** (also available on [readthedocs.org](http://libpointmatcher.readthedocs.org/) but might not be up-to-date).
+**Quick link for the tutorial pages: [Tutorials](http://libpointmatcher.readthedocs.org/).
 
 Those tutorials are written using Markdown syntax and stored in the project's `/doc` folder.  Their scope ranges from introductory material on performing point cloud registration to instructions for the more experienced developer on how to extend the library's codebase. 
 

diff --git a/UseDoxygen.cmake b/UseDoxygen.cmake
@@ -109,10 +109,10 @@ if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)
 
 	configure_file(${DOXYFILE_IN} Doxyfile IMMEDIATE @ONLY)
 
-	get_target_property(DOC_TARGET doc TYPE)
 	if(NOT DOC_TARGET)
 		add_custom_target(doc)
 	endif()
+	get_target_property(DOC_TARGET doc TYPE)
 
 	add_dependencies(doc doxygen)
 endif()
diff --git a/build_system/.jetbrains_run_config/[LPM] run all bats tests.run.xml b/build_system/.jetbrains_run_config/[LPM] run all bats tests.run.xml
@@ -9,7 +9,7 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="true" />
     <envs>
       <env name="DOCKER_CONTEXT" value="desktop-linux" />

diff --git a/...config/bash lpm_execute_compose_over_build_matrix.bash › build _service_ _popup_.run.xml b/...config/bash lpm_execute_compose_over_build_matrix.bash › build _service_ _popup_.run.xml
@@ -9,7 +9,7 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs>
       <env name="BUILDX_BUILDER" value="local-builder-multiarch-virtual" />

diff --git a/...ompose_over_build_matrix.bash › build dependencies_arm64v8 ci_PR_arm64v8 _popup_.run.xml b/...ompose_over_build_matrix.bash › build dependencies_arm64v8 ci_PR_arm64v8 _popup_.run.xml
@@ -9,11 +9,11 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs>
       <env name="BUILDX_BUILDER" value="local-builder-multiarch-virtual" />
     </envs>
     <method v="2" />
   </configuration>
-</component>
+</component>
diff --git a/...build_matrix.bash › build dependencies-general dependencies (BUILD MATRIX SUBSET).run.xml b/...build_matrix.bash › build dependencies-general dependencies (BUILD MATRIX SUBSET).run.xml
@@ -9,11 +9,11 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs>
       <env name="BUILDX_BUILDER" value="local-builder-multiarch-virtual" />
     </envs>
     <method v="2" />
   </configuration>
-</component>
+</component>
diff --git a/...h lpm_execute_compose_over_build_matrix.bash › build test_compilation__ (Release).run.xml b/...h lpm_execute_compose_over_build_matrix.bash › build test_compilation__ (Release).run.xml
@@ -1,6 +1,6 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="bash lpm_crawl_libpointmatcher_build_matrix.bash › build test_compilation_* (compilation test)" type="ShConfigurationType" folderName="[LPM] C | Execute compose over build matrix">
-    <option name="SCRIPT_TEXT" value="bash lpm_crawl_libpointmatcher_build_matrix.bash --fail-fast --cmake-build-type-build-matrix-override Release --os-name-build-matrix-override ubuntu --ubuntu-version-build-matrix-override jammy -- build test_compilation_prefixed_path test_compilation_auto_path_resolution" />
+    <option name="SCRIPT_TEXT" value="bash lpm_crawl_libpointmatcher_build_matrix.bash --fail-fast --cmake-build-type-build-matrix-override Release --os-name-build-matrix-override ubuntu --ubuntu-version-build-matrix-override focal -- build test_compilation_prefixed_path test_compilation_auto_path_resolution" />
     <option name="INDEPENDENT_SCRIPT_PATH" value="true" />
     <option name="SCRIPT_PATH" value="" />
     <option name="SCRIPT_OPTIONS" value="" />
@@ -9,7 +9,7 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs>
       <env name="BUILDX_BUILDER" value="local-builder-multiarch-virtual" />

diff --git a/...er_build_matrix.bash › build test_compilation_prefixed_path (BUILD MATRIX SUBSET).run.xml b/...er_build_matrix.bash › build test_compilation_prefixed_path (BUILD MATRIX SUBSET).run.xml
@@ -9,11 +9,11 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs>
       <env name="BUILDX_BUILDER" value="local-builder-multiarch-virtual" />
     </envs>
     <method v="2" />
   </configuration>
-</component>
+</component>
diff --git a/..._over_build_matrix.bash › build&push dependencies-general dependencies (AS IN TC).run.xml b/..._over_build_matrix.bash › build&push dependencies-general dependencies (AS IN TC).run.xml
@@ -9,7 +9,7 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs>
       <env name="BUILDX_BUILDER" value="local-builder-multiarch-virtual" />

diff --git a/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix.bash.run.xml b/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix.bash.run.xml
@@ -9,7 +9,7 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs />
     <method v="2" />

diff --git a/...ystem/.jetbrains_run_config/test_execute_compose_over_build_matrix_with_flag.bash.run.xml b/...ystem/.jetbrains_run_config/test_execute_compose_over_build_matrix_with_flag.bash.run.xml
@@ -9,7 +9,7 @@
     <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
     <option name="INTERPRETER_PATH" value="/bin/zsh" />
     <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="false" />
+    <option name="EXECUTE_IN_TERMINAL" value="true" />
     <option name="EXECUTE_SCRIPT_FILE" value="false" />
     <envs />
     <method v="2" />

diff --git a/build_system/tests/tests_docker_interactive/Dockerfile.build_system_test b/build_system/tests/tests_docker_interactive/Dockerfile.build_system_test
@@ -1,5 +1,6 @@
 ARG BASE_IMAGE=ubuntu
-ARG BASE_IMAGE_TAG=jammy
+#ARG BASE_IMAGE_TAG=jammy
+ARG BASE_IMAGE_TAG=bionic
 FROM ${BASE_IMAGE}:${BASE_IMAGE_TAG} AS base-image
 
 LABEL org.opencontainers.image.authors="[email protected]"

diff --git a/build_system/ubuntu/lpm_install_dependencies_general_ubuntu.bash b/build_system/ubuntu/lpm_install_dependencies_general_ubuntu.bash
@@ -20,16 +20,19 @@ TMP_CWD=$(pwd)
 LPM_PATH=$(git rev-parse --show-toplevel)
 cd "${LPM_PATH}/build_system" || cd "${LPM_PATH}" || exit 1
 
+NBS_PATH=${NBS_PATH:-"${LPM_PATH}/build_system/utilities/norlab-build-system"}
+N2ST_PATH=${N2ST_PATH:-"${LPM_PATH}/build_system/utilities/norlab-shell-script-tools"}
+
 # ....Load environment variables from file.........................................................
 set -o allexport
 source .env
 set +o allexport
 
 # ....Helper function..............................................................................
 # import shell functions from utilities library
-N2ST_PATH=${N2ST_PATH:-"${LPM_PATH}/build_system/utilities/norlab-shell-script-tools"}
 source "${N2ST_PATH}/import_norlab_shell_script_tools_lib.bash"
 
+
 # Set environment variable IMAGE_ARCH_AND_OS
 cd "${N2ST_PATH}"/src/utility_scripts/ && source "which_architecture_and_os.bash"
 

diff --git a/build_system/ubuntu/lpm_install_libpointmatcher_ubuntu.bash b/build_system/ubuntu/lpm_install_libpointmatcher_ubuntu.bash
@@ -218,6 +218,10 @@ if [[ $TEST_RUN  == true ]]; then
   BUILD_EXIT_CODE=0
   INSTALL_EXIT_CODE=0
 else
+  #  # Hack to prevent LPM cmake build failure in ubuntu bionic
+  #  BOOST_ROOT=$(whereis boost) && export BOOST_ROOT
+  #  CMAKE_FLAGS=( -D BOOST_ROOT="$BOOST_ROOT" "${CMAKE_FLAGS[@]}" )
+
   cmake "${CMAKE_FLAGS[@]}" "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}"
 
   BUILD_EXIT_CODE=$?