Skip to content

Commit b180d03

Browse files
authored
Merge pull request #103 from GiulioRomualdi/patch-1
Add conda installation information in the README
2 parents 53124b1 + b807267 commit b180d03

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@ A flexible, modern, cross-platform C++ recursive Bayesian estimation library.
55
[![BayesFilters home](https://img.shields.io/badge/BayesFilters-Home%20%26%20Doc-E0C57F.svg?style=flat-square)](https://robotology.github.io/bayes-filters-lib/doc/html/index.html) [![Latest Release](https://img.shields.io/github/release/robotology/bayes-filters-lib.svg?style=flat-square&label=Latest%20Release)](https://github.com/robotology/bayes-filters-lib/releases) [![SemVer](https://img.shields.io/badge/SemVer-2.0.0-brightgreen.svg?style=flat-square)](http://semver.org/) [![ZenHub](https://img.shields.io/badge/Shipping_faster_with-ZenHub-blue.svg?style=flat-square)](https://zenhub.com)
66

77

8-
# Overview
8+
## Overview
99
- [⚠️ About versioning](#️-about-versioning)
1010
- [📖 Background](#-background)
11+
- [📦Installing with conda](#-installing-with-conda)
1112
- [🎛 Dependencies](#-dependencies)
12-
- [🔨 Build and link the library](#-build-and-link-the-library)
13+
- [🔨 Build and test the library](#-build-and-test-the-library)
1314
- [🔬 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)
1517
- [📑 Reference](#-reference)
1618

1719

18-
# ⚠️ About versioning
20+
## ⚠️ About versioning
1921
The project is undergoing _heavy_ development: APIs will be subject to changes quite often.
2022
To be able to understand API compatibility during development, the project will follow [SemVer](http://semver.org/) specs.
2123

@@ -26,7 +28,7 @@ In particular, the library will have **zero major version**, i.e. **0.MINOR.PATC
2628
4. Additional labels for pre-release and build metadata are available as extensions to the 0.MINOR.PATCH format.
2729

2830

29-
# 📖 Background
31+
## 📖 Background
3032
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.
3133
Estimation theory dates back to the work of Gauss on determining the orbit of celestial bodies from their observations.
3234
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
3739

3840
The aim of this library is to provide _interfaces_ and _implementations_ for new and existing recursive Bayesian filters!
3941

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+
```
4047

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
4251
Bayes Filters Library depends on
4352
- [Eigen3](https://bitbucket.org/eigen/eigen/) - `version >= 3.3 (no beta)`
4453

4554

46-
# 🔨 Build and link the library
55+
### 🔨 Build and test the library
4756
Use the following commands to build, install and link the library.
4857

49-
### Build
58+
#### Build
5059
With `make` facilities:
5160
```bash
5261
$ git clone https://github.com/robotology/bayes-filters-lib
@@ -70,18 +79,7 @@ $ [sudo] ninja install
7079
You can also generate IDE project (e.g. Visual Studio and Xcode) to use their
7180
build tool facilities.
7281

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`:
75-
```cmake
76-
...
77-
find_package(BayesFilters 0.MINOR.PATCH EXACT REQUIRED)
78-
...
79-
target_link_libraries(<target> BayesFilters::BayesFilters)
80-
...
81-
```
82-
83-
84-
# 🔬 Test the library
82+
### 🔬 Test the library
8583
We have designed some test to run with `CMake` to see whether everything run smoothly or not. Simply use
8684
```cmake
8785
$ ctest [-VV]
@@ -90,12 +88,21 @@ to run all the tests.
9088

9189
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!_
9290

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`:
93+
```cmake
94+
...
95+
find_package(BayesFilters 0.MINOR.PATCH EXACT REQUIRED)
96+
...
97+
target_link_libraries(<target> BayesFilters::BayesFilters)
98+
...
99+
```
93100

94-
# 📝 API documentation and example code
101+
## 📝 API documentation and example code
95102
Doxygen-generated documentation is available [here](https://robotology.github.io/bayes-filters-lib/doc/html/index.html).
96103

97104

98-
# 📑 Reference
105+
## 📑 Reference
99106
[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.
100107
[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.
101108
[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

Comments
 (0)