Update README

ethz-asl · Sep 13, 2024 · 50708fd · 50708fd
1 parent 79c6510
commit 50708fd
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 41 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -6,7 +6,7 @@ on:
 
 jobs:
   build-docs:
-    name: Build docs
+    name: Build
     runs-on: ubuntu-20.04
     steps:
       - name: Fetch the package's repository

diff --git a/.github/workflows/ros1.yml b/.github/workflows/ros1.yml
@@ -101,8 +101,8 @@ jobs:
           catkin build wavemap_all --no-status --force-color
           echo "::remove-matcher owner=problem-matcher-gcc::"
 
-  test:
-    name: Test
+  install:
+    name: Install
     needs: [ workspace-container, build ]
     runs-on: ubuntu-20.04
     container:
@@ -120,35 +120,24 @@ jobs:
           key: ${{ secrets.CCACHE_CACHE_VERSION }}|ubuntu-20.04-gcc-ros1
           create-symlink: true
 
-      - name: Build regular code
+      - name: Enable catkin install mode
         working-directory: ${{ env.CATKIN_WS_PATH }}
         shell: bash
-        run: catkin build wavemap_all --no-status --force-color --cmake-args -DDCHECK_ALWAYS_ON=ON
+        run: |
+          catkin config --install
+          catkin clean -bdi -y
 
-      - name: Build unit tests
+      - name: Build all wavemap packages
         working-directory: ${{ env.CATKIN_WS_PATH }}
         shell: bash
         run: |
+          . /opt/ros/noetic/setup.sh
           echo "::add-matcher::./.github/problem-matchers/gcc.json"
-          catkin build wavemap_all --no-status --force-color --no-deps --cmake-args -DDCHECK_ALWAYS_ON=ON --catkin-make-args tests
+          catkin build wavemap_all --no-status --force-color
           echo "::remove-matcher owner=problem-matcher-gcc::"
 
-      - name: Run unit tests
-        working-directory: ${{ env.CATKIN_WS_PATH }}
-        shell: bash
-        run: |
-          all_tests_passed=1
-          source devel/setup.bash
-          for f in devel/lib/wavemap*/test_*
-            do $f --gtest_color=yes || all_tests_passed=0
-          done
-          if [ $all_tests_passed -ne 1 ]; then
-            echo "Not all tests passed!"
-            exit 1
-          fi
-
-  install:
-    name: Install
+  test:
+    name: Test
     needs: [ workspace-container, build ]
     runs-on: ubuntu-20.04
     container:
@@ -166,18 +155,29 @@ jobs:
           key: ${{ secrets.CCACHE_CACHE_VERSION }}|ubuntu-20.04-gcc-ros1
           create-symlink: true
 
-      - name: Enable catkin install mode
+      - name: Build regular code
         working-directory: ${{ env.CATKIN_WS_PATH }}
         shell: bash
-        run: |
-          catkin config --install
-          catkin clean -bdi -y
+        run: catkin build wavemap_all --no-status --force-color --cmake-args -DDCHECK_ALWAYS_ON=ON
 
-      - name: Build all wavemap packages
+      - name: Build unit tests
         working-directory: ${{ env.CATKIN_WS_PATH }}
         shell: bash
         run: |
-          . /opt/ros/noetic/setup.sh
           echo "::add-matcher::./.github/problem-matchers/gcc.json"
-          catkin build wavemap_all --no-status --force-color
+          catkin build wavemap_all --no-status --force-color --no-deps --cmake-args -DDCHECK_ALWAYS_ON=ON --catkin-make-args tests
           echo "::remove-matcher owner=problem-matcher-gcc::"
+
+      - name: Run unit tests
+        working-directory: ${{ env.CATKIN_WS_PATH }}
+        shell: bash
+        run: |
+          all_tests_passed=1
+          source devel/setup.bash
+          for f in devel/lib/wavemap*/test_*
+            do $f --gtest_color=yes || all_tests_passed=0
+          done
+          if [ $all_tests_passed -ne 1 ]; then
+            echo "Not all tests passed!"
+            exit 1
+          fi
diff --git a/README.md b/README.md
@@ -1,29 +1,27 @@
 # Wavemap
 <div>
-<a href="https://github.com/ethz-asl/wavemap/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/ci.yml?label=test&logo=githubactions&logoColor=white" alt="test"/></a>
-<a href="https://github.com/ethz-asl/wavemap/actions/workflows/cd.yml"><img src="https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/cd.yml?label=deploy&logo=githubactions&logoColor=white" alt="deploy"/></a>
-<a href="https://ethz-asl.github.io/wavemap/"><img src="https://img.shields.io/badge/docs-online-brightgreen?logo=sphinx" alt="docs"/></a>
-<a href="https://github.com/ethz-asl/wavemap/releases"><img src="https://img.shields.io/github/v/tag/ethz-asl/wavemap?label=release&logo=github" alt="release"/></a>
-<a href="https://github.com/ethz-asl/wavemap/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-BSD%203-blue?logo=bsd" alt="license"/></a>
-<a href="https://ethz-asl.github.io/wavemap/pages/contributing.html"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen" alt="contributions welcome"/></a>
+<a href="https://github.com/ethz-asl/wavemap/actions/workflows/cpp.yml"><img src="https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/cpp.yml?label=C%2b%2b&logo=C%2b%2b&logoColor=white" alt="C++"/></a>
+<a href="https://github.com/ethz-asl/wavemap/actions/workflows/python.yml"><img src="https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/python.yml?label=Python&logo=python&logoColor=white" alt="Python"/></a>
+<a href="https://github.com/ethz-asl/wavemap/actions/workflows/ros1.yml"><img src="https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/ros1.yml?label=ROS1&logo=ros&logoColor=white" alt="ROS1"/></a>
+<a href="https://github.com/ethz-asl/wavemap/actions/workflows/docs.yml"><img src="https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/docs.yml?label=Docs&logo=sphinx&logoColor=white" alt="Docs"/></a>
 </div>
 <div>
-<a href="https://ethz-asl.github.io/wavemap/pages/installation.html"><img src="https://img.shields.io/badge/Intel-0071C5?logo=intel" alt="Intel"/></a>
-<a href="https://ethz-asl.github.io/wavemap/pages/installation.html"><img src="https://img.shields.io/badge/AMD-ED1C24?logo=amd" alt="AMD"/></a>
-<a href="https://ethz-asl.github.io/wavemap/pages/installation.html"><img src="https://img.shields.io/badge/Arm-0091BD?logo=arm&logoColor=white" alt="Arm"/></a>
-<a href="https://github.com/ethz-asl/wavemap/pkgs/container/wavemap"><img src="https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=black" alt="docker"/></a>
+<a href="https://github.com/ethz-asl/wavemap/releases"><img src="https://img.shields.io/github/v/tag/ethz-asl/wavemap?label=Release&logo=github" alt="Release"/></a>
+<a href="https://github.com/ethz-asl/wavemap/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-BSD%203-blue?logo=bsd" alt="License"/></a>
 </div>
 
 [![3D reconstruction of Newer College's Cloister](https://github.com/ethz-asl/wavemap/assets/6238939/e432d4ea-440d-4e9d-adf9-af3ae3b09a10)](https://www.youtube.com/live/ftQhK75Ri1E?si=9txTYyJ78wQuhyN-&t=733)
 
 ## Hierarchical, multi-resolution volumetric mapping
-
 Wavemap achieves state-of-the-art memory and computational efficiency by combining Haar wavelet compression and a coarse-to-fine measurement integration scheme. Advanced measurement models allow it to attain exceptionally high recall rates on challenging obstacles like thin objects.
 
 The framework is very flexible and supports several data structures, measurement integration methods, and sensor models out of the box. The ROS interface can, for example, easily be configured to fuse multiple sensor inputs, such as a LiDAR configured with a range of 20m and several depth cameras up to a resolution of 1cm, into a single multi-resolution occupancy grid map.
 
+Wavemap provides [C++](https://ethz-asl.github.io/wavemap/pages/tutorials/cpp) and [Python](https://ethz-asl.github.io/wavemap/pages/tutorials/python) APIs and an interface to [ROS1](https://ethz-asl.github.io/wavemap/pages/tutorials/ros1). The code is extensively tested on Intel, AMD and ARM CPUs. Example Docker files [are available](https://github.com/ethz-asl/wavemap/tree/main/tooling/docker) and documented in the [installation instructions](https://ethz-asl.github.io/wavemap/pages/installation/index). We [welcome contributions](https://ethz-asl.github.io/wavemap/pages/contributing).
+
 ⭐ If you find wavemap useful, star it on GitHub to get notified of new releases!
 
+
 ## Documentation
 The framework's documentation is hosted on [GitHub Pages](https://ethz-asl.github.io/wavemap/).