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
+16-18
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,9 @@
1
1
# Getting Started
2
2
3
3
RoboStack is a bundling of ROS for Linux, macOS and Windows using the [Conda package manager](https://docs.conda.io/en/latest/), based on top of [conda-forge](https://conda-forge.org/).
4
-
We have also extended support to the [Pixi](https://pixi.sh/latest/) package manager, which builds upon the foundations of, and maintains compatabillity with the Conda ecosystem.
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
-
[Here](https://pixi.sh/dev/switching_from/conda/) is a comparison of how Pixi works when compared to Conda/Mamba
7
-
8
-
You can install Robostack using either Mamba or pixi.
6
+
You can install Robostack using either Mamba or Pixi. We recommend using Pixi for any new installations.
9
7
=== "Mamba"
10
8
## Install Mamba
11
9
To get started, you'll need a base conda installation. We recommend using the [`miniforge`](https://github.com/conda-forge/miniforge) installer.
@@ -22,7 +20,7 @@ You can install Robostack using either Mamba or pixi.
22
20
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.
23
21
24
22
!!! warning "Do not source the system ROS environment"
25
-
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.
23
+
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.
26
24
27
25
!!! warning "PowerShell is not supported"
28
26
@@ -153,7 +151,7 @@ You can install Robostack using either Mamba or pixi.
153
151
After installation, you may need to restart your terminal for the `pixi` command to be available.
154
152
155
153
!!! warning "Do not source the system ROS environment"
156
-
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.
154
+
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.
157
155
158
156
159
157
## Install RoboStack using Pixi
@@ -175,7 +173,7 @@ You can install Robostack using either Mamba or pixi.
@@ -208,7 +207,7 @@ You can install Robostack using either Mamba or pixi.
208
207
colcon-common-extensions = "*"
209
208
rosdep = "*"
210
209
211
-
#jazzy
210
+
#jazzy
212
211
[feature.jazzy]
213
212
channels = ["https://prefix.dev/robostack-jazzy"]
214
213
@@ -218,23 +217,22 @@ You can install Robostack using either Mamba or pixi.
218
217
rosdep = "*"
219
218
```
220
219
```bash
221
-
#Save and exit pixi.toml
220
+
#Save and exit pixi.toml
222
221
pixi install
223
-
#You can now start an environment with your desired robostack distribution using one of the below commands (either executed from within the project directory or by appending `--manifest-path` and pointing to your project directory):
222
+
#You can now start an environment with your desired robostack distribution using one of the below commands (either executed from within the project directory or by appending `--manifest-path` and pointing to your project directory):
224
223
225
-
#ROS noetic
224
+
#ROS noetic
226
225
pixi shell -e noetic
227
226
228
-
#ROS humble
227
+
#ROS humble
229
228
pixi shell -e humble
230
229
231
-
#ROS jazzy
230
+
#ROS jazzy
232
231
pixi shell -e jazzy
233
-
234
232
```
235
233
236
234
## Testing installation
237
-
After installation, you should test if you are able to run `rviz` and other ros tools.
235
+
After installation, you should test if you are able to run `rviz`/`rviz2` and other ROS tools.
238
236
239
237
!!! note "Reminder"
240
238
The ROS environment activation is included automatically. There is no need to add a `source` command in the `~/.bashrc`
@@ -338,7 +336,7 @@ After installation, you should test if you are able to run `rviz` and other ros
0 commit comments