update RU installation instruction to jazzy

This commit is contained in:
Ilya Uraev 2025-02-18 14:21:11 +03:00
parent 50a97b0cbd
commit 42361d0b40

View file

@ -1,15 +1,15 @@
# Инструкция по установке фреймворка
**Важно!** Совместимо только с операционной системой Ubuntu 22.04.
**Важно!** Совместимо только с операционной системой Ubuntu 24.04.
Ниже приведена последовательность шагов для настройки фреймворка.
---
## Шаг 1: Установка ROS2 Humble
## Шаг 1: Установка ROS2 Jazzy
Для начала установите [ROS2 Humble](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debs.html).
Рекомендуется минимальная установка `ros-humble-ros-base`, а также пакет `ros-dev-tools`.
Для начала установите [ROS2 Jazzy](https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html).
Рекомендуется минимальная установка `ros-jazzy-ros-base`, а также пакет `ros-dev-tools`.
---
@ -17,7 +17,7 @@
Перед продолжением убедитесь, что среда ROS2 активирована. Для этого выполните:
```sh
source /opt/ros/humble/setup.bash
source /opt/ros/jazzy/setup.bash
```
---
@ -33,29 +33,14 @@ rosdep update
```sh
cd
mkdir -p robossembler-ws/src && cd robossembler-ws/src
git clone --recurse-submodules https://gitlab.com/robossembler/robossembler-ros2.git
git clone https://gitlab.com/robossembler/robossembler-ros2.git
```
Далее необходимо собрать [`ros2_control`](https://github.com/ros-controls/ros2_control) из исходников, используя этот [форк](https://github.com/solid-sinusoid/ros2_control/tree/gz-ros2-cartesian-controllers).
Также доступна альтернатива с использованием [`vsctool`](https://github.com/dirk-thomas/vcstool), который входит в состав базовых пакетов ROS2.
Если вы решили использовать `vcstool`, нужные пакеты будут клонированы в тоже рабочее пространство, что и сам фреймворк. Команда для этого выглядит следующим образом:
```sh
vcs import . < robossembler-ros2/repos/all-deps.repos
```
Вы также можете установить все необходимые библиотеки Python, выполнив команду:
```shell
pip install -r robossembler-ros2/repos/requirements.txt
# Если Вы получили ошибку с установкой Shapely
sudo apt install libgeos-dev
```
> **[!ВНИМАНИЕ]**
> Убедитесь, что у вас установлен `git lfs`. В файле `requirements.txt` указан модуль `rbs_assets_library`, который содержит большие файлы и устанавливается как Python-модуль.
Эти команды нужно выполнять в директории `robossembler-ws/src/`.
Установка зависимостей при помощи `rosdep`
```sh
cd ~/robossembler-ws
@ -74,14 +59,66 @@ colcon build
```sh
cd
mkdir -p robossembler-ws/src && cd robossembler-ws/src
git clone --recurse-submodules https://gitlab.com/robossembler/robossembler-ros2.git
git clone https://gitlab.com/robossembler/robossembler-ros2.git
# Или, если вы предпочитаете Radicle:
git clone --recurse-submodules https://seed.robossembler.org/z46gtVRpXaXrGQM7Fxiqu7pLy7kip.git robossembler-ros2
git clone https://seed.robossembler.org/z46gtVRpXaXrGQM7Fxiqu7pLy7kip.git robossembler-ros2
rad clone rad:z46gtVRpXaXrGQM7Fxiqu7pLy7kip
vcs import . < robossembler-ros2/repos/all-deps.repos
pip install -r robossembler-ros2/repos/requirements.txt
cd ..
rosdep install --from-paths src -y --ignore-src --rosdistro ${ROS_DISTRO}
colcon build
```
---
## Установка зависимостей среды выполнения (runtime) Python
Для корректной работы с Python-зависимостями в проекте необходимо создать виртуальное окружение в директории с рабочим пространством (workspace).
### Создание виртуального окружения
```sh
cd ~/robossembler-ws
sudo apt update && sudo apt install -y python3-virtualenv
virtualenv -p python3 .venv
```
После этого создается виртуальное окружение `.venv` в рабочем пространстве. Чтобы исключить его из сборки colcon, создадим файл `COLCON_IGNORE`:
```sh
touch .venv/COLCON_IGNORE
```
### Использование виртуального окружения
Для установки пакетов в виртуальное окружение его необходимо активировать:
```sh
source .venv/bin/activate
```
После активации можно устанавливать зависимости из файла `requirements.txt`:
```sh
pip install -r src/robossembler-ros2/repos/requirements.txt
```
Чтобы обеспечить доступ к установленным в виртуальное окружение библиотекам, необходимо добавить путь к ним в переменную окружения `PYTHONPATH`:
```sh
export PYTHONPATH=$PYTHONPATH:$HOME/robossembler-ws/.venv/lib/python3.12/site-packages
```
Для автоматического применения этого пути при каждом запуске терминала рекомендуется добавить эту строку в файл `~/.bashrc`:
```sh
echo 'export PYTHONPATH=$PYTHONPATH:$HOME/robossembler-ws/.venv/lib/python3.12/site-packages' >> ~/.bashrc
source ~/.bashrc
```
### Отключение виртуального окружения перед сборкой
При сборке проекта colcon использует глобальные Python-библиотеки, поэтому перед сборкой необходимо деактивировать виртуальное окружение:
```sh
deactivate
```