You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/GettingStarted.md
+94Lines changed: 94 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ RoboStack is a bundling of ROS for Linux, macOS and Windows using the [Conda pac
4
4
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.
5
5
6
6
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.
7
8
8
9
=== "Micromamba"
9
10
## Install Micromamba
@@ -70,6 +71,62 @@ You can install Robostack using either Micromamba or Pixi. We recommend using Pi
70
71
- 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)
71
72
72
73
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:
- 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
+
73
130
=== "Pixi"
74
131
## Install Pixi
75
132
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
253
310
micromamba deactivate
254
311
```
255
312
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.
0 commit comments