Skip to content

Commit 1e8211c

Browse files
committed
docs: update with suggested pixi.toml from Ruben
1 parent 889d1e5 commit 1e8211c

File tree

1 file changed

+28
-95
lines changed

1 file changed

+28
-95
lines changed

docs/GettingStarted.md

Lines changed: 28 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -173,151 +173,84 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo
173173
```
174174

175175
Open the newly created pixi.toml in your favourite text editor and paste the below configuration into the file (overwriting the configuration created by `pixi init`):
176-
``` bash title="pixi.toml"
176+
```toml title="pixi.toml"
177177
[project]
178178
name = "robostack"
179-
version = "0.1.0"
180179
description = "Development environment for RoboStack ROS packages"
181-
authors = ["Your Name <[email protected]>"]
182180
channels = ["https://prefix.dev/conda-forge"]
183181
platforms = ["linux-64", "win-64", "osx-64", "osx-arm64", "linux-aarch64"]
184182

185183
# This will automatically activate the ros workspace on activation
186-
[target.win-64.activation]
184+
[target.win.activation]
187185
scripts = ["install/setup.bat"]
188186

189-
[target.linux-64.activation]
190-
scripts = ["install/setup.bash"]
191-
192-
[target.linux-aarch64.activation]
193-
scripts = ["install/setup.bash"]
194-
195-
[target.osx-64.activation]
196-
scripts = ["install/setup.zsh"]
197-
198-
[target.osx-arm64.activation]
199-
scripts = ["install/setup.zsh"]
187+
[target.unix.activation]
188+
# For activation scripts, we use bash for Unix-like systems
189+
scripts = ["install/setup.bash"]
200190

201191
[target.win-64.dependencies]
202192
# vs2022_win-64 = "*" # Uncomment if using Visual Studio 2022
203193

194+
# To build you can use - `pixi run -e <ros distro> build <Any other temporary args>`
195+
[feature.build.target.win-64.tasks]
196+
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
197+
198+
[feature.build.target.unix.tasks]
199+
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
200+
201+
# Dependencies used by all environments
204202
[dependencies]
205203
python = "*"
204+
# Build tools
206205
compilers = "*"
207206
cmake = "*"
208207
pkg-config = "*"
209208
make = "*"
210209
ninja = "*"
210+
# ROS specific tools
211+
rosdep = "*"
212+
colcon-common-extensions = "*"
211213

212214
[target.linux.dependencies]
213215
libgl-devel = "*"
214216

217+
# Define all the different ROS environments
218+
# Each environment corresponds to a different ROS distribution
219+
# and can be activated using the `pixi run/shell -e <environment>` command.
215220
[environments]
216-
noetic = { features = ["noetic"] }
217-
humble = { features = ["humble"] }
218-
jazzy = { features = ["jazzy"] }
219-
kilted = { features = ["kilted"] }
221+
noetic = { features = ["noetic", "build"] }
222+
humble = { features = ["humble", "build"] }
223+
jazzy = { features = ["jazzy", "build"] }
224+
kilted = { features = ["kilted", "build"] }
220225

221-
# noetic
226+
### ROS Noetic ####
222227
[feature.noetic]
223228
channels = ["https://prefix.dev/robostack-noetic"]
224229

225230
[feature.noetic.dependencies]
226231
ros-noetic-desktop = "*"
227232
catkin_tools = "*"
228-
rosdep = "*"
229-
230-
# To build you can use - pixi run -e noetic build <Any other temporary args>
231-
[feature.noetic.target.win-64.tasks]
232-
build = "colcon build --merge-install --cmake-args -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
233-
234-
[feature.noetic.target.linux-64.tasks]
235-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
236-
237-
[feature.noetic.target.linux-aarch64.tasks]
238-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
239-
240-
[feature.noetic.target.osx-64.tasks]
241-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
242233

243-
[feature.noetic.target.osx-arm64.tasks]
244-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
245-
246-
# humble
234+
### ROS Humble ####
247235
[feature.humble]
248236
channels = ["https://prefix.dev/robostack-humble"]
249237

250238
[feature.humble.dependencies]
251239
ros-humble-desktop = "*"
252-
colcon-common-extensions = "*"
253-
rosdep = "*"
254-
255-
# To build you can use - pixi run -e humble build <Any other temporary args>
256-
[feature.humble.target.win-64.tasks]
257-
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
258-
259-
[feature.humble.target.linux-64.tasks]
260-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
261-
262-
[feature.humble.target.linux-aarch64.tasks]
263-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
264-
265-
[feature.humble.target.osx-64.tasks]
266-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
267-
268-
[feature.humble.target.osx-arm64.tasks]
269-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
270-
271240

272-
# jazzy
241+
### ROS Jazzy ####
273242
[feature.jazzy]
274243
channels = ["https://prefix.dev/robostack-jazzy"]
275244

276245
[feature.jazzy.dependencies]
277246
ros-jazzy-desktop = "*"
278-
colcon-common-extensions = "*"
279-
rosdep = "*"
280-
281-
# To build you can use - pixi run -e jazzy build <Any other temporary args>
282-
[feature.jazzy.target.win-64.tasks]
283-
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
284-
285-
[feature.jazzy.target.linux-64.tasks]
286-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
287-
288-
[feature.jazzy.target.linux-aarch64.tasks]
289-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
290-
291-
[feature.jazzy.target.osx-64.tasks]
292-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
293247

294-
[feature.jazzy.target.osx-arm64.tasks]
295-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
296-
297-
# kilted
248+
### ROS Kilted ####
298249
[feature.kilted]
299250
channels = ["https://prefix.dev/robostack-kilted"]
300251

301252
[feature.kilted.dependencies]
302253
ros-kilted-desktop = "*"
303-
colcon-common-extensions = "*"
304-
rosdep = "*"
305-
306-
# To build you can use - pixi run -e kilted build <Any other temporary args>
307-
[feature.kilted.target.win-64.tasks]
308-
build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
309-
310-
[feature.kilted.target.linux-64.tasks]
311-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
312-
313-
[feature.kilted.target.linux-aarch64.tasks]
314-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
315-
316-
[feature.kilted.target.osx-64.tasks]
317-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
318-
319-
[feature.kilted.target.osx-arm64.tasks]
320-
build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY"
321254
```
322255

323256
```bash

0 commit comments

Comments
 (0)