Skip to content

Commit fbd3d08

Browse files
committed
docs: Correct some documentation around pixi, and take more advantage of pixi features in pixi.toml example
1 parent 998f18e commit fbd3d08

File tree

1 file changed

+62
-4
lines changed

1 file changed

+62
-4
lines changed

docs/GettingStarted.md

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,6 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
138138

139139
The command will also automatically add `LocalAppData/pixi/bin` to your path allowing you to invoke `pixi` from anywhere.
140140

141-
!!! warning "PowerShell is not supported"
142-
On Windows, Powershell is not supported, only the Command Prompt terminal is supported.
143-
144141
!!! tip "Prerequisites"
145142
- Windows users need Visual Studio (2019 or 2022) with C++ support
146143
- You can download them here: [https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-160](https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-160)
@@ -172,6 +169,22 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
172169
channels = ["https://fast.prefix.dev/conda-forge"]
173170
platforms = ["linux-64", "win-64", "osx-64", "osx-arm64", "linux-aarch64"]
174171

172+
# This will automatically activate the ros workspace on activation
173+
[target.win-64.activation]
174+
scripts = ["install/setup.bat"]
175+
176+
[target.linux-64.activation]
177+
scripts = ["install/setup.bash"]
178+
179+
[target.linux-aarch64.activation]
180+
scripts = ["install/setup.bash"]
181+
182+
[target.osx-64.activation]
183+
scripts = ["install/setup.bash"]
184+
185+
[target.osx-arm64.activation]
186+
scripts = ["install/setup.bash"]
187+
175188
[target.win-64.dependencies]
176189
# vs2022_win-64 = "*" # Uncomment if using Visual Studio 2022
177190

@@ -200,6 +213,16 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
200213
catkin_tools = "*"
201214
rosdep = "*"
202215

216+
# To build you can use - pixi run -e noetic build <Any other temporary args>
217+
[feature.noetic.target.win-64.tasks]
218+
build = "colcon build --merge-install --cmake-args -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
219+
220+
[feature.noetic.target.linux-64.tasks]
221+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
222+
223+
[feature.noetic.target.linux-aarch64.tasks]
224+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
225+
203226
# humble
204227
[feature.humble]
205228
channels = ["https://prefix.dev/robostack-humble"]
@@ -209,6 +232,16 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
209232
colcon-common-extensions = "*"
210233
rosdep = "*"
211234

235+
# To build you can use - pixi run -e humble build <Any other temporary args>
236+
[feature.humble.target.win-64.tasks]
237+
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
238+
239+
[feature.humble.target.linux-64.tasks]
240+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
241+
242+
[feature.humble.target.linux-aarch64.tasks]
243+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
244+
212245
# jazzy
213246
[feature.jazzy]
214247
channels = ["https://prefix.dev/robostack-jazzy"]
@@ -217,6 +250,16 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
217250
ros-jazzy-desktop = "*"
218251
colcon-common-extensions = "*"
219252
rosdep = "*"
253+
254+
# To build you can use - pixi run -e jazzy build <Any other temporary args>
255+
[feature.jazzy.target.win-64.tasks]
256+
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
257+
258+
[feature.jazzy.target.linux-64.tasks]
259+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
260+
261+
[feature.jazzy.target.linux-aarch64.tasks]
262+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
220263
```
221264
```bash
222265
# Save and exit pixi.toml
@@ -320,15 +363,25 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
320363
=== "Pixi"
321364

322365
!!! note
323-
Remember that Pixi environments can only be activated from within your project directory.
366+
Remember if trying to activate the pixi from outside the project directory, provide the path to the pixi.toml with `--manifest-path`.
324367

325368
**ROS1**
326369
```bash title="First terminal"
327370
cd robostack
371+
pixi run -e noetic roscore
372+
```
373+
alternatively,
374+
```bash title="First terminal"
375+
cd robostack
328376
pixi shell -e noetic
329377
roscore
330378
```
331379

380+
```bash title="Second terminal"
381+
cd robostack
382+
pixi run -e noetic rviz
383+
```
384+
alternatively,
332385
```bash title="Second terminal"
333386
cd robostack
334387
pixi shell -e noetic
@@ -338,6 +391,11 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
338391
**ROS2**
339392
```bash title="Terminal"
340393
cd robostack
394+
pixi run -e humble rviz2 # OR jazzy
395+
```
396+
alternatively,
397+
```bash title="Terminal"
398+
cd robostack
341399
pixi shell -e humble # OR jazzy
342400
rviz2
343401
```

0 commit comments

Comments
 (0)