instructions

.github/workflows/tests.yml

@@ -7,14 +7,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Installing build dependencies
-      run: ./install_dependencies.sh
+      run: scripts/install_dependencies.sh
     - name: Installing rednose
       run: pip3 install --break-system-packages .[dev]
     - name: Unit Tests
@@ -25,7 +25,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Installing build dependencies
-      run: ./install_dependencies.sh
+      run: scripts/install_dependencies.sh
     - name: Installing rednose
       run: pip3 install --break-system-packages .[dev]
     - name: Static analysis

README.md

@@ -49,3 +49,17 @@ A lot of measurements do not come from a Gaussian distribution and as such have
 of the Kalman filter. This can cause a lot of performance issues if not dealt with. This library allows the use of a mahalanobis
 distance statistical test on the incoming measurements to deal with this. Note that good initialization is critical to prevent
 good measurements from being rejected.
+
+### Building
+On ubuntu:
+``` bash
+scripts/install_dependencies.sh
+pip install .
+```
+or run some test:
+On ubuntu:
+``` bash
+scripts/install_dependencies.sh
+pip install .[dev]
+pytest
+```

install_dependencies.sh → scripts/install_dependencies.sh

@@ -17,4 +17,3 @@ fi
 
 $SUDO apt-get update
 $SUDO apt-get install -y --no-install-recommends capnproto libcapnp-dev clang wget git autoconf libtool curl make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev python3-openssl libeigen3-dev python3-pip python3-dev
-