Skip to content

Commit 994185b

Browse files
instructions for Conda
1 parent 40bf229 commit 994185b

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

docs/GettingStarted.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ RoboStack is a bundling of ROS for Linux, macOS and Windows using the [Conda pac
44
We have also extended support to the [Pixi](https://pixi.sh/latest/) package manager, which builds upon the foundations of, and maintains compatability with the Conda ecosystem. [Here](https://pixi.sh/dev/switching_from/conda/) is a comparison of how Pixi works when compared to Conda/Mamba.
55

66
You can install Robostack using either Micromamba or Pixi. We recommend using Pixi for any new installations.
7+
Note that the instructions for Conda and Micromamba are virtually identical apart from the installation.
78

89
=== "Micromamba"
910
## Install Micromamba
@@ -70,6 +71,62 @@ You can install Robostack using either Micromamba or Pixi. We recommend using Pi
7071
- You can download them here: [https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-170](https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-170)
7172

7273

74+
=== "Conda"
75+
## Install conda
76+
On Debian- and RPM-based distributions, we recommend the [Debian and RPM repository for miniconda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/rpm-debian.html). To source the base environment:
77+
```bash
78+
source /opt/conda/etc/profile.d/conda.sh
79+
```
80+
81+
For other OSes and Linux distributions, we recommend using the [`miniforge`](https://github.com/conda-forge/miniforge) installer.
82+
83+
!!! important "Do not install ROS packages in the `base` environment"
84+
Make sure to _not_ install the ROS packages in your base environment as this leads to issues down the track. On the other hand, conda and mamba must not be installed in the `ros_env`, they should only be installed in base.
85+
86+
!!! important "Do not source the system ROS environment"
87+
When there is an installation available of ROS on the system, in non-conda environments, there will be interference with the environments as the `PYTHONPATH` set in the setup script conflicts with the conda environment.
88+
89+
## Installing ROS
90+
!!! note
91+
There are different channels depending on the version of ROS that you wish to install, to add these channels and install your desired version, you can run the following:
92+
=== "ROS 1 Noetic"
93+
```bash
94+
# Create a ros-noetic desktop environment
95+
conda create -n ros_env -c conda-forge -c robostack-noetic ros-noetic-desktop
96+
```
97+
=== "ROS 2 Humble"
98+
```bash
99+
# Create a ros-humble desktop environment
100+
conda create -n ros_env -c conda-forge -c robostack-humble ros-humble-desktop
101+
```
102+
=== "ROS 2 Jazzy"
103+
```bash
104+
# Create a ros-jazzy desktop environment
105+
conda create -n ros_env -c conda-forge -c robostack-jazzy ros-jazzy-desktop
106+
```
107+
108+
=== "ROS 2 Kilted"
109+
```bash
110+
# Create a ros-kilted desktop environment
111+
conda create -n ros_env -c conda-forge -c robostack-kilted ros-kilted-desktop
112+
```
113+
114+
```bash
115+
# Activate the environment
116+
conda activate ros_env
117+
```
118+
119+
## Installing tools for local development
120+
```bash title="Default tools to help with local development of ROS packages"
121+
conda activate ros_env
122+
conda install -c conda-forge compilers cmake pkg-config make ninja colcon-common-extensions catkin_tools rosdep
123+
```
124+
125+
!!! tip "Developing on Windows"
126+
- Windows users also need Visual Studio 2022 with C++ support
127+
- You can download them here: [https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-170](https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-170)
128+
129+
73130
=== "Pixi"
74131
## Install Pixi
75132
To install `pixi` you can run the following command in your terminal:
@@ -253,6 +310,43 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
253310
micromamba deactivate
254311
```
255312

313+
=== "Conda"
314+
**ROS 1**
315+
```bash title="First terminal"
316+
conda activate ros_env
317+
roscore
318+
```
319+
320+
```bash title="Second terminal"
321+
conda activate ros_env
322+
rviz
323+
```
324+
325+
**ROS 2**
326+
!!! note
327+
ROS 2 has the benefit of not needing a `roscore`, so only a single terminal is needed to run a tool.
328+
329+
```bash title="Terminal"
330+
conda activate ros_env
331+
rviz2
332+
```
333+
334+
If you run into any issues or for any frequently asked questions, you can check the [FAQ page](https://robostack.github.io/FAQ.html)
335+
336+
## Updating
337+
Updating all packages in your environment is as easy as:
338+
339+
```bash
340+
conda update --all
341+
```
342+
343+
## Deactivating
344+
The (de)activation of the ros workspace goes in together with the conda environment. So running the corresponding (de)activation command will also (un)source the ros environment.
345+
346+
```bash
347+
conda deactivate
348+
```
349+
256350
=== "Pixi"
257351

258352
!!! note

0 commit comments

Comments
 (0)