Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to include instructions for using an environment #167

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

xela-95
Copy link
Member

@xela-95 xela-95 commented Jan 30, 2024

Following the results of #163, this PR adds to the README instructions on how to use an environment to install all the needed dependencies to run the walking-controllers simulation https://github.com/robotology/walking-controllers?tab=readme-ov-file#computer-how-to-run-the-simulation .

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Stefano Dafarra <stefano.dafarra@gmail.com>
@@ -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:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure on how to update this sentence.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry my comment was originally pointing to the line below, 107. It is now ambiguous since the CMAKE_INSTALL_PREFIX is updated also with the conda environment but in such case there is no need to add to the .bashrc the environment variables listed.

Maybe it can be rephrased as: "Notice: if you're using the robotology-superbuild, you don't need to use sudo if you specify the CMAKE_INSTALL_PREFIX. In such case, it's essential to include the following lines in either the .bashrc or .bash_profile file:"

README.md Outdated Show resolved Hide resolved
Copy link
Member

@traversaro traversaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently I had a pending comment I never sent.

It's possible to create the environment via the following command:

```sh
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use -c conda-forge -c robotology, not the other way around. conda-forge needs to have higher priority as some packages have older versions in robotology and newer versions in conda-forge .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants