From fbd3d0839b09f1dc7b82b628bdb5fd1149f83226 Mon Sep 17 00:00:00 2001 From: Tony Paulussen Date: Mon, 9 Jun 2025 22:51:47 +0200 Subject: [PATCH 1/3] docs: Correct some documentation around pixi, and take more advantage of pixi features in pixi.toml example --- docs/GettingStarted.md | 66 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 4 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 49aff3a9..fd4b6e95 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -138,9 +138,6 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo The command will also automatically add `LocalAppData/pixi/bin` to your path allowing you to invoke `pixi` from anywhere. - !!! warning "PowerShell is not supported" - On Windows, Powershell is not supported, only the Command Prompt terminal is supported. - !!! tip "Prerequisites" - Windows users need Visual Studio (2019 or 2022) with C++ support - 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 channels = ["https://fast.prefix.dev/conda-forge"] platforms = ["linux-64", "win-64", "osx-64", "osx-arm64", "linux-aarch64"] + # This will automatically activate the ros workspace on activation + [target.win-64.activation] + scripts = ["install/setup.bat"] + + [target.linux-64.activation] + scripts = ["install/setup.bash"] + + [target.linux-aarch64.activation] + scripts = ["install/setup.bash"] + + [target.osx-64.activation] + scripts = ["install/setup.bash"] + + [target.osx-arm64.activation] + scripts = ["install/setup.bash"] + [target.win-64.dependencies] # vs2022_win-64 = "*" # Uncomment if using Visual Studio 2022 @@ -200,6 +213,16 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo catkin_tools = "*" rosdep = "*" + # To build you can use - pixi run -e noetic build + [feature.noetic.target.win-64.tasks] + build = "colcon build --merge-install --cmake-args -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.noetic.target.linux-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.noetic.target.linux-aarch64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + # humble [feature.humble] channels = ["https://prefix.dev/robostack-humble"] @@ -209,6 +232,16 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo colcon-common-extensions = "*" rosdep = "*" + # To build you can use - pixi run -e humble build + [feature.humble.target.win-64.tasks] + build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.humble.target.linux-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.humble.target.linux-aarch64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + # jazzy [feature.jazzy] channels = ["https://prefix.dev/robostack-jazzy"] @@ -217,6 +250,16 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo ros-jazzy-desktop = "*" colcon-common-extensions = "*" rosdep = "*" + + # To build you can use - pixi run -e jazzy build + [feature.jazzy.target.win-64.tasks] + build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.jazzy.target.linux-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.jazzy.target.linux-aarch64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" ``` ```bash # Save and exit pixi.toml @@ -320,15 +363,25 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot === "Pixi" !!! note - Remember that Pixi environments can only be activated from within your project directory. + Remember if trying to activate the pixi from outside the project directory, provide the path to the pixi.toml with `--manifest-path`. **ROS1** ```bash title="First terminal" cd robostack + pixi run -e noetic roscore + ``` + alternatively, + ```bash title="First terminal" + cd robostack pixi shell -e noetic roscore ``` + ```bash title="Second terminal" + cd robostack + pixi run -e noetic rviz + ``` + alternatively, ```bash title="Second terminal" cd robostack pixi shell -e noetic @@ -338,6 +391,11 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot **ROS2** ```bash title="Terminal" cd robostack + pixi run -e humble rviz2 # OR jazzy + ``` + alternatively, + ```bash title="Terminal" + cd robostack pixi shell -e humble # OR jazzy rviz2 ``` From 889d1e5fae1d5fef4b1050665d6cb62b7266f746 Mon Sep 17 00:00:00 2001 From: Tony Paulussen Date: Thu, 26 Jun 2025 13:35:00 +0200 Subject: [PATCH 2/3] docs: update pixi osx examples --- docs/GettingStarted.md | 47 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 41 insertions(+), 6 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 30c718b0..89e5e0ed 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -193,10 +193,10 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo scripts = ["install/setup.bash"] [target.osx-64.activation] - scripts = ["install/setup.bash"] + scripts = ["install/setup.zsh"] [target.osx-arm64.activation] - scripts = ["install/setup.bash"] + scripts = ["install/setup.zsh"] [target.win-64.dependencies] # vs2022_win-64 = "*" # Uncomment if using Visual Studio 2022 @@ -237,6 +237,12 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo [feature.noetic.target.linux-aarch64.tasks] build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + [feature.noetic.target.osx-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.noetic.target.osx-arm64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + # humble [feature.humble] channels = ["https://prefix.dev/robostack-humble"] @@ -256,6 +262,13 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo [feature.humble.target.linux-aarch64.tasks] build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + [feature.humble.target.osx-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.humble.target.osx-arm64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + # jazzy [feature.jazzy] channels = ["https://prefix.dev/robostack-jazzy"] @@ -265,6 +278,22 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo colcon-common-extensions = "*" rosdep = "*" + # To build you can use - pixi run -e jazzy build + [feature.jazzy.target.win-64.tasks] + build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.jazzy.target.linux-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.jazzy.target.linux-aarch64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.jazzy.target.osx-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.jazzy.target.osx-arm64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + # kilted [feature.kilted] channels = ["https://prefix.dev/robostack-kilted"] @@ -274,14 +303,20 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo colcon-common-extensions = "*" rosdep = "*" - # To build you can use - pixi run -e jazzy build - [feature.jazzy.target.win-64.tasks] + # To build you can use - pixi run -e kilted build + [feature.kilted.target.win-64.tasks] build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - [feature.jazzy.target.linux-64.tasks] + [feature.kilted.target.linux-64.tasks] build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - [feature.jazzy.target.linux-aarch64.tasks] + [feature.kilted.target.linux-aarch64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.kilted.target.osx-64.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.kilted.target.osx-arm64.tasks] build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" ``` From 1e8211cdf9d493c05ad884779fade54d33901400 Mon Sep 17 00:00:00 2001 From: Tony Paulussen Date: Thu, 26 Jun 2025 14:32:35 +0200 Subject: [PATCH 3/3] docs: update with suggested pixi.toml from Ruben --- docs/GettingStarted.md | 123 ++++++++++------------------------------- 1 file changed, 28 insertions(+), 95 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 89e5e0ed..a8b666fe 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -173,151 +173,84 @@ You can install Robostack using either Mamba or Pixi. We recommend using Pixi fo ``` 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`): - ``` bash title="pixi.toml" + ```toml title="pixi.toml" [project] name = "robostack" - version = "0.1.0" description = "Development environment for RoboStack ROS packages" - authors = ["Your Name "] channels = ["https://prefix.dev/conda-forge"] platforms = ["linux-64", "win-64", "osx-64", "osx-arm64", "linux-aarch64"] # This will automatically activate the ros workspace on activation - [target.win-64.activation] + [target.win.activation] scripts = ["install/setup.bat"] - [target.linux-64.activation] - scripts = ["install/setup.bash"] - - [target.linux-aarch64.activation] - scripts = ["install/setup.bash"] - - [target.osx-64.activation] - scripts = ["install/setup.zsh"] - - [target.osx-arm64.activation] - scripts = ["install/setup.zsh"] + [target.unix.activation] + # For activation scripts, we use bash for Unix-like systems + scripts = ["install/setup.bash"] [target.win-64.dependencies] # vs2022_win-64 = "*" # Uncomment if using Visual Studio 2022 + # To build you can use - `pixi run -e build ` + [feature.build.target.win-64.tasks] + build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + [feature.build.target.unix.tasks] + build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" + + # Dependencies used by all environments [dependencies] python = "*" + # Build tools compilers = "*" cmake = "*" pkg-config = "*" make = "*" ninja = "*" + # ROS specific tools + rosdep = "*" + colcon-common-extensions = "*" [target.linux.dependencies] libgl-devel = "*" + # Define all the different ROS environments + # Each environment corresponds to a different ROS distribution + # and can be activated using the `pixi run/shell -e ` command. [environments] - noetic = { features = ["noetic"] } - humble = { features = ["humble"] } - jazzy = { features = ["jazzy"] } - kilted = { features = ["kilted"] } + noetic = { features = ["noetic", "build"] } + humble = { features = ["humble", "build"] } + jazzy = { features = ["jazzy", "build"] } + kilted = { features = ["kilted", "build"] } - # noetic + ### ROS Noetic #### [feature.noetic] channels = ["https://prefix.dev/robostack-noetic"] [feature.noetic.dependencies] ros-noetic-desktop = "*" catkin_tools = "*" - rosdep = "*" - - # To build you can use - pixi run -e noetic build - [feature.noetic.target.win-64.tasks] - build = "colcon build --merge-install --cmake-args -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.noetic.target.linux-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.noetic.target.linux-aarch64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.noetic.target.osx-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - [feature.noetic.target.osx-arm64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - # humble + ### ROS Humble #### [feature.humble] channels = ["https://prefix.dev/robostack-humble"] [feature.humble.dependencies] ros-humble-desktop = "*" - colcon-common-extensions = "*" - rosdep = "*" - - # To build you can use - pixi run -e humble build - [feature.humble.target.win-64.tasks] - build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.humble.target.linux-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.humble.target.linux-aarch64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.humble.target.osx-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.humble.target.osx-arm64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - # jazzy + ### ROS Jazzy #### [feature.jazzy] channels = ["https://prefix.dev/robostack-jazzy"] [feature.jazzy.dependencies] ros-jazzy-desktop = "*" - colcon-common-extensions = "*" - rosdep = "*" - - # To build you can use - pixi run -e jazzy build - [feature.jazzy.target.win-64.tasks] - build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.jazzy.target.linux-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.jazzy.target.linux-aarch64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.jazzy.target.osx-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - [feature.jazzy.target.osx-arm64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - # kilted + ### ROS Kilted #### [feature.kilted] channels = ["https://prefix.dev/robostack-kilted"] [feature.kilted.dependencies] ros-kilted-desktop = "*" - colcon-common-extensions = "*" - rosdep = "*" - - # To build you can use - pixi run -e kilted build - [feature.kilted.target.win-64.tasks] - build = "colcon build --merge-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.kilted.target.linux-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.kilted.target.linux-aarch64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.kilted.target.osx-64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" - - [feature.kilted.target.osx-arm64.tasks] - build = "colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DPython_FIND_VIRTUALENV=ONLY -DPython3_FIND_VIRTUALENV=ONLY" ``` ```bash pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy