From b2e4cfac70d198dbf0b408a553411f0a0eb96a36 Mon Sep 17 00:00:00 2001 From: Alessandro Croci Date: Tue, 30 Jan 2024 16:13:01 +0100 Subject: [PATCH 1/3] Update README to include instructions for using an environment --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 634caa14d..619f296ee 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,24 @@ Eprint = {arXiv:1809.02167}, * [Catch2](https://github.com/catchorg/Catch2): to compile the tests. # :hammer: Build the suite + +The dependencies can be installed either using the [robotology-superbuild](https://github.com/robotology/robotology-superbuild) or via an isolated environment (see [here](https://github.com/robotology/robotology-superbuild/blob/master/doc/install-mambaforge.md) to learn how to install mambaforge). + +It's possible to create the environment via the following command: + +```sh +mamba create -n walking -c robotology -c conda-forge bipedal-locomotion-framework=0.18.0 idyntree yarp icub-contrib-common icub-main osqp-eigen qpoases libunicycle-footstep-planner gazebo catch2 gazebo-yarp-plugins whole-body-estimators icub-models ergocub-software +``` + +This will create an environment called `walking` that can be activated via: + +```sh +mamba activate walking +``` + +> [!NOTE] +> Remember to activate this environment in every terminal used to run the simulation. + ## Linux/macOs ```sh @@ -84,6 +102,8 @@ cmake ../ make [sudo] make install ``` +If using an environment, remember to set `CMAKE_INSTALL_PREFIX` to the value of `$CONDA_PREFIX`. + Notice: `sudo` is not necessary if you specify the `CMAKE_INSTALL_PREFIX`. In this case it is necessary to add in the `.bashrc` or `.bash_profile` the following lines: ```sh export WalkingControllers_INSTALL_DIR=/path/where/you/installed/ From ead5b3190d02465c57823a660506f232bf34f783 Mon Sep 17 00:00:00 2001 From: Alessandro Croci <57228872+xela-95@users.noreply.github.com> Date: Tue, 30 Jan 2024 17:27:52 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Stefano Dafarra --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 619f296ee..0fa69c892 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Eprint = {arXiv:1809.02167}, # :hammer: Build the suite -The dependencies can be installed either using the [robotology-superbuild](https://github.com/robotology/robotology-superbuild) or via an isolated environment (see [here](https://github.com/robotology/robotology-superbuild/blob/master/doc/install-mambaforge.md) to learn how to install mambaforge). +The dependencies can be installed either using the [robotology-superbuild](https://github.com/robotology/robotology-superbuild) (that installs also this repo) or via an isolated environment (see [here](https://github.com/robotology/robotology-superbuild/blob/master/doc/install-mambaforge.md) to learn how to install mambaforge). It's possible to create the environment via the following command: From c26ebf6c4fc6a17b3a172a36f534a535b119381f Mon Sep 17 00:00:00 2001 From: Alessandro Croci Date: Tue, 30 Jan 2024 17:33:33 +0100 Subject: [PATCH 3/3] Updated README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fa69c892..f4939ac6c 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ The dependencies can be installed either using the [robotology-superbuild](https It's possible to create the environment via the following command: ```sh -mamba create -n walking -c robotology -c conda-forge bipedal-locomotion-framework=0.18.0 idyntree yarp icub-contrib-common icub-main osqp-eigen qpoases libunicycle-footstep-planner gazebo catch2 gazebo-yarp-plugins whole-body-estimators icub-models ergocub-software +mamba create -n walking -c robotology -c conda-forge bipedal-locomotion-framework idyntree yarp icub-contrib-common icub-main osqp-eigen qpoases libunicycle-footstep-planner gazebo catch2 gazebo-yarp-plugins whole-body-estimators icub-models ergocub-software ``` This will create an environment called `walking` that can be activated via: