docs: update docs to reflect rai on pypi and interfaces on apt #612
Conversation
maciejmajek
changed the title
| 1. Install rai whoami: | ||
|
|
||
| ```bash | ||
| pip install rai-whoami |
There was a problem hiding this comment.
Same considerations for ubuntu 24.04 as in rai-core.
There was a problem hiding this comment.
@maciejmajek I think it would be beneficial to mention the tip about ros2 packages here as well
docs/setup/install.md
Outdated
|
|
||
| When installing RAI in a virtual environment (as opposed to the system interpreter), you need to expand the PYTHONPATH to include the virtual environment's site-packages directory. | ||
|
|
||
| Here's how to do it when RAI is installed via git clone: [setup_shell.sh](https://github.com/RobotecAI/rai/blob/245efa95cdb83a81294bc28da814962bff84be20/setup_shell.sh#L32) |
There was a problem hiding this comment.
This will only work if virtualenv is created with the same python version as ros2 native python.
I think it would be good to mention that as well. Python version used in ros2 can be different depending on ubuntu version (u22-python3.10, u24-python3.12). This can be checked using:
find /opt/ros/${ROS_DISTRO}/lib/ -type d -name "python3.*" | rev | cut -f1 -d '/' | rev
.
Alse, I tried installing rai in uv virtualenv and had such error, because uv used python3.11 by default. To make it work I had to use python3.10 explicitely:
cd workdir
uv venv --python 3.10
uv add rai-core
And I managed to run react.py example using:
cd workdir
source .venv/bin/activate
python react.py
There was a problem hiding this comment.
Fokin hell m8. A simplistic way of installing rai is getting super complex. Nevertheless, yeah, it should be mentioned
|
A note should be added that it's advised to run the demos with poetry install |
There was a problem hiding this comment.
@maciejmajek Leaving some minor style comments. Otherwise LGTM!
| 1. Install rai whoami: | ||
|
|
||
| ```bash | ||
| pip install rai-whoami |
There was a problem hiding this comment.
@maciejmajek I think it would be beneficial to mention the tip about ros2 packages here as well
|
|
||
| ## Installing RAI | ||
|
|
||
| ??? tip "Virtual environment" |
There was a problem hiding this comment.
I would make it untoggled by default
Co-authored-by: Bartek Boczek <[email protected]>
Co-authored-by: Bartek Boczek <[email protected]>
Co-authored-by: Bartek Boczek <[email protected]>
Co-authored-by: Bartek Boczek <[email protected]>
Purpose
To provide instructions for anyone wanting to install rai with pip
Proposed Changes
Documentation changes
Issues
#607
Testing