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
-[:package: Install with conda (recommended)](#package-install-with-conda-recommended)
@@ -37,10 +34,9 @@ The **bipedal-locomotion-framework** project is a _suite_ of libraries for achie
37
34
# :page_facing_up: Mandatory dependencies
38
35
The **bipedal-locomotion-framework** project is versatile and can be used to compile only some components.
39
36
40
-
The minimum required dependencies are `Eigen3`, `iDynTree` and `spdlog`. If you want to build the tests please remember to install `Catch2`. If you are interested in the python bindings generation please install `python3` and `pybind11` in your system.
37
+
The minimum required dependencies are `Eigen3`, `iDynTree` and `spdlog`. If you want to build the tests please remember to install `Catch2`. If you are interested in the Python bindings generation please install `python3` and `pybind11` in your system.
41
38
42
39
# :orange_book: Exported components
43
-
44
40
The **bipedal-locomotion-framework** project consists of several components. The components are stored in the [`src`](./src) folder and their compilation depends on the installed dependencies.
@@ -73,22 +69,22 @@ The **bipedal-locomotion-framework** project consists of several components. The
73
69
|[`TextLogging`](./src/TextLogging)| Helper library to display messages into the console |[`YARP`](https://www.yarp.it/git-master/) (only if you want the `YARP` implementation) [`ros-humble`](https://docs.ros.org/en/humble/) (if you want the `ros2` implementation) |
74
70
|[`YarpUtilities`](./src/YarpUtilities)| Utilities library for retrieving data and from YARP structures |[`YARP`](https://www.yarp.it/git-master/)|
75
71
76
-
:warning: Including `BipedalLocomotion/Framework.h` may result in higher compilation time because of the inclusion of headers which may not be used in your project. It is always suggested to follow the [IWYU](https://github.com/include-what-you-use/include-what-you-use/blob/cc0fad4be0db26e40713b6076263f204a311b573/docs/WhyIWYU.md) paradigm. This applies also for the CMake targets. It is suggested to link only the targets used in your project.
72
+
:warning: Including `BipedalLocomotion/Framework.h` may result in higher compilation time because of the inclusion of headers which may not be used in your project. It is always suggested to follow the [IWYU](https://github.com/include-what-you-use/include-what-you-use/blob/cc0fad4be0db26e40713b6076263f204a311b573/docs/WhyIWYU.md) paradigm. This applies also to the CMake targets. It is suggested to link only the targets used in your project.
77
73
78
74
# :package: Install with conda (recommended)
79
-
You can easily the library with [`conda`](https://anaconda.org/robotology/bipedal-locomotion-framework) using the following command
75
+
You can easily the library with [`conda`](https://anaconda.org/conda-forge/bipedal-locomotion-framework) using the following command
`conda` will automatically install all the required dipendencies.
81
+
`conda` will automatically install all the required dependencies.
86
82
87
83
88
84
# :hammer: Build the suite
89
85
The **bipedal-locomotion-framework** can be built on Windows, macOS, and Linux. The easiest way to compile the library is to use the [`robotology-superbuild`](https://github.com/robotology/robotology-superbuild). If you enable the profiles `ROBOTOLOGY_ENABLE_DYNAMICS` and `ROBOTOLOGY_ENABLE_DYNAMICS_FULL_DEPS` in the `robotology-superbuild` you will automatically clone and build **bipedal-locomotion-framework** and all the dependencies.
90
86
91
-
If you do not want to use the `robotology-superbuild` you can manually compile the code in the repository running the following command in the terminal
87
+
If you do not want to use the `robotology-superbuild` you can manually compile the code in the repository by running the following command in the terminal
**Remark:** If you manually compile the framework remember to install the dependencies required by the component you are interested in.
103
99
104
100
# :computer: Some utilities
105
-
106
101
The **bipedal-locomotion-framework** ships also some utilities that can help you in the everyday tests on a real robot. You can find them in the [`utilities` folder](./utilities). Each utility contains a well-documented` README` where you can find further details.
107
102
108
103
# :snake: Python
109
-
110
-
**bipedal-locomotion-framework** provides also python bindings. Only a small set of the components implemented in the library have the corresponding python bindings.
104
+
**bipedal-locomotion-framework** also provides Python bindings. Only a small set of the components implemented in the library have the corresponding Python bindings.
111
105
112
106
If you want to compile the bindings please install `python3` and `pybind11` in your system then you can run the following `CMake` command in your `build` folder
**Disclaimer:** The python bindings are currently supported on Linux.
118
+
**Disclaimer:** The Python bindings are currently supported on Linux.
125
119
126
120
# :running: How to use the libraries
127
121
The **bipedal-locomotion-framework** provides native `CMake` support which allows the library to be easily used in `CMake` projects.
128
122
129
-
**bipedal-locomotion-framework** exports the `CMake` targets presented in [Exported components](#orange_book-exported-components) section. The targets can be imported using the `find_package` command and used by calling `target_link_libraries`.
123
+
**bipedal-locomotion-framework** exports the `CMake` targets presented in the [Exported components](#orange_book-exported-components) section. The targets can be imported using the `find_package` command and used by calling `target_link_libraries`.
130
124
131
-
For instance, `Math` component can be used as follows:
125
+
For instance, the `Math` component can be used as follows:
The list of the targets can be found in the table [:orange\_book: Exported components](#orange_book-exported-components).
142
136
143
137
# :gear: Contributing
144
-
145
-
**bipedal-locomotion-framework** is an open-source project, and is thus built with your contributions. We strongly encourage you to open an issue with your feature request. Once the issue has been opened, you can also proceed with a pull-request :rocket:
138
+
**bipedal-locomotion-framework** is an open-source project, and is thus built with your contributions. We strongly encourage you to open an issue with your feature request. Once the issue has been opened, you can also proceed with a pull request:rocket:
0 commit comments