You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[📦Installing with conda](#-installing-with-conda)
11
12
-[🎛 Dependencies](#-dependencies)
12
-
-[🔨 Build and link the library](#-build-and-link-the-library)
13
+
-[🔨 Build and test the library](#-build-and-test-the-library)
13
14
-[🔬 Test the library](#-test-the-library)
14
-
-[📝 API documentation and example code](#-api-documentaion-and-example-code)
15
+
-[🔗 Link the library](#-link-the-library)
16
+
-[📝 API documentation and example code](#-api-documentation-and-example-code)
15
17
-[📑 Reference](#-reference)
16
18
17
19
18
-
# ⚠️ About versioning
20
+
##⚠️ About versioning
19
21
The project is undergoing _heavy_ development: APIs will be subject to changes quite often.
20
22
To be able to understand API compatibility during development, the project will follow [SemVer](http://semver.org/) specs.
21
23
@@ -26,7 +28,7 @@ In particular, the library will have **zero major version**, i.e. **0.MINOR.PATC
26
28
4. Additional labels for pre-release and build metadata are available as extensions to the 0.MINOR.PATCH format.
27
29
28
30
29
-
# 📖 Background
31
+
##📖 Background
30
32
The main interest of the present library is estimation, which refers to inferring the values of a set of unknown variables from information provided by a set of noisy measurements whose values depend on such unknown variables.
31
33
Estimation theory dates back to the work of Gauss on determining the orbit of celestial bodies from their observations.
32
34
These studies led to the technique known as _Least Squares_.
@@ -37,16 +39,23 @@ Popular Bayes filters are the **Kalman** [1]-[4] and **particle filters** [5]-[7
37
39
38
40
The aim of this library is to provide _interfaces_ and _implementations_ for new and existing recursive Bayesian filters!
39
41
42
+
## 📦 Installing with conda
43
+
You can install the binaries with conda. All the dependencies will be automatically installed in the conda environment.
44
+
```bash
45
+
conda install -c conda-forge libbayes-filters-lib
46
+
```
40
47
41
-
# 🎛 Dependencies
48
+
## Building from sources
49
+
If you want to build the project from sources you need to follow the following passages
50
+
### 🎛 Dependencies
42
51
Bayes Filters Library depends on
43
52
-[Eigen3](https://bitbucket.org/eigen/eigen/) - `version >= 3.3 (no beta)`
44
53
45
54
46
-
# 🔨 Build and link the library
55
+
###🔨 Build and test the library
47
56
Use the following commands to build, install and link the library.
You can also generate IDE project (e.g. Visual Studio and Xcode) to use their
71
80
build tool facilities.
72
81
73
-
### Link
74
-
Once the library is installed, you can link it using `CMake` with as little effort as writing the following line of code in your project `CMakeLists.txt`:
We have designed some test to run with `CMake` to see whether everything run smoothly or not. Simply use
86
84
```cmake
87
85
$ ctest [-VV]
@@ -90,12 +88,21 @@ to run all the tests.
90
88
91
89
Tests are also a nice **starting points** to learn how to use the library and how to implement your own filters! _Just have a look at them!_
92
90
91
+
## 🔗 Link the library
92
+
Once the library is installed, you can link it using `CMake` with as little effort as writing the following line of code in your project `CMakeLists.txt`:
Doxygen-generated documentation is available [here](https://robotology.github.io/bayes-filters-lib/doc/html/index.html).
96
103
97
104
98
-
# 📑 Reference
105
+
##📑 Reference
99
106
[1] R. E. Kalman, “A new approach to linear filtering and prediction problems,” Trans. _Trans. ASME - Journal of Basic Engineering_, vol. 82 (Series D), no. 1, pp. 35– 45, 1960.
100
107
[2] R. E. Kalman and R. S. Bucy, “New results in linear filtering and prediction theory,” _Trans. ASME - Journal of Basic Engineering_, vol. 83 (Series D), no. 1, pp. 95–108, 1961.
101
108
[3] L. A. McGee, S. F. Schmidt and G. L. Smith, “Applications of statistical filter theory to the optimal estimation of position and velocity on board a circumlunar vehicle”, _NASA Technical Report R-135_, Tech. Rep., 1962.
0 commit comments