-
Notifications
You must be signed in to change notification settings - Fork 301
Initial documentation for Gazebo rotary #685
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
j-rivero
wants to merge
7
commits into
master
Choose a base branch
from
jrivero/rotary
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+157
−2
Open
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
feff705
Initial documentation for Gazebo rotary
j-rivero cd34137
Simplify rotary
j-rivero 01afee8
Merge branch 'master' into jrivero/rotary
j-rivero 15860e8
Fix paths
j-rivero d22fcf2
Merge branch 'master' into jrivero/rotary
j-rivero 3dc224c
Apply suggestions from code review
j-rivero 9907df1
Merge branch 'master' into jrivero/rotary
j-rivero File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| # Rotary release | ||
|
|
||
| **Rotary** is a rolling release stream of Gazebo built continuously from the | ||
| `main` branches of every Gazebo library. Unlike the dated codename releases | ||
| (Fortress, Harmonic, Jetty, …), rotary has no fixed version: it is built | ||
| every night. It is intended for Gazebo maintainers, continuous | ||
| integration systems, and early adopters who want to test unreleased | ||
| changes before they ship in a named collection. | ||
|
|
||
| :::{warning} | ||
| Rotary is a rolling, unstable stream. Breakage is expected, and versions | ||
| may change under you on every `apt upgrade` or `brew upgrade`. Rotary is | ||
| **not recommended for production use**. New Gazebo users should install | ||
| one of the binary releases listed in [Releases](../releases.md) instead. | ||
| ::: | ||
|
|
||
| ## Package naming | ||
|
|
||
| Wherever a Gazebo package name contains `gz-`, a `rotary-` infix is | ||
| injected to produce the rotary alias. The aliases point to unversioned | ||
| upstream packages, so installing a rotary alias always pulls whatever is | ||
| currently being built from `main`. | ||
|
|
||
| ### Ubuntu / Debian | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
|
|
||
|
|
||
| | Regular package | Rotary alias | | ||
| |------------------------|---------------------------------| | ||
| | `libgz-cmake-dev` | `libgz-rotary-cmake-dev` | | ||
| | `gz-plugin-cli` | `gz-rotary-plugin-cli` | | ||
| | `python3-gz-math` | `python3-gz-rotary-math` | | ||
| | `libsdformat-dev` (*) | `libgz-rotary-sdformat-dev` | | ||
|
|
||
| (*) sdformat is a special case: its package names do not contain `gz-`, | ||
| so the rotary alias adds a `gz-rotary-` prefix. | ||
|
|
||
| ### Homebrew (macOS) | ||
|
|
||
| | Regular formula | Rotary alias | | ||
| |-----------------|---------------------| | ||
| | `gz-mathN` | `gz-rotary-math` | | ||
| | `sdformatN` | `gz-rotary-sdformat`| | ||
|
|
||
|
|
||
| ### Umbrella metapackage | ||
|
|
||
| On both Ubuntu and Homebrew, the `gz-rotary` metapackage pulls in the full | ||
| set of rotary libraries, mirroring how `gz-jetty` or `gz-harmonic` work for | ||
| named collections. | ||
|
|
||
| ## Installing rotary on Ubuntu | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
|
|
||
| :::{note} | ||
| Rotary binaries are published into the existing **nightly** apt repository | ||
| at `http://packages.osrfoundation.org/gazebo/{ubuntu,debian}-nightly`, so | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
| the versioning scheme documented in | ||
| [Debian/Ubuntu versioning in nightly and prerelease binaries](versioning_pre_nightly.md) | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
| applies to rotary unchanged. | ||
| ::: | ||
|
|
||
| First install the prerequisite tools: | ||
|
|
||
| ```bash | ||
| sudo apt-get update | ||
| sudo apt-get install curl lsb-release gnupg | ||
| ``` | ||
|
|
||
| Add the OSRF GPG key and configure the **nightly** apt repository (which | ||
| hosts rotary packages): | ||
|
|
||
| ```bash | ||
| sudo curl https://packages.osrfoundation.org/gazebo.gpg --output /usr/share/keyrings/pkgs-osrf-archive-keyring.gpg | ||
| echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/pkgs-osrf-archive-keyring.gpg] http://packages.osrfoundation.org/gazebo/ubuntu-nightly $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/gazebo-nightly.list > /dev/null | ||
| sudo apt-get update | ||
| ``` | ||
|
|
||
| Then install the rotary metapackage: | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| sudo apt-get install gz-rotary | ||
| ``` | ||
|
|
||
| All rotary libraries should be ready to use and the `gz sim` app ready to | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
| run. | ||
|
|
||
| ### Uninstalling rotary | ||
|
|
||
| ```bash | ||
| sudo apt remove gz-rotary && sudo apt autoremove | ||
| ``` | ||
|
|
||
| ## Installing rotary on macOS (Homebrew) | ||
|
|
||
| Rotary formulae are published through the | ||
| [`osrf/simulation`](https://github.com/osrf/homebrew-simulation) tap: | ||
|
|
||
| ```bash | ||
| brew tap osrf/simulation | ||
| brew install gz-rotary | ||
| ``` | ||
|
|
||
| Per-library formulae are also available using the `gz-rotary-<library>` | ||
| naming scheme, for example: | ||
|
|
||
| ```bash | ||
| brew install gz-rotary-math gz-rotary-sim | ||
| ``` | ||
|
|
||
| The initial rollout of rotary brew formulae is tracked in | ||
| [osrf/homebrew-simulation#3287](https://github.com/osrf/homebrew-simulation/pull/3287). | ||
|
|
||
| ## Windows | ||
|
|
||
| There is currently no binary distribution of rotary on Windows. Windows | ||
| users who want to run rotary need to build it from source. | ||
|
|
||
| The existing [Source Installation on Windows 10 or 11](../install_windows_src.md) | ||
| guide for Jetty describes the full toolchain (Visual Studio, Pixi, | ||
| `colcon`). The same procedure applies to rotary — the only change is | ||
|
j-rivero marked this conversation as resolved.
Outdated
|
||
| the `vcs import` step, which must point at `collection-rotary.yaml` from | ||
| [gazebo-tooling/gazebodistro](https://github.com/gazebo-tooling/gazebodistro) | ||
| instead of the Jetty collection file: | ||
|
|
||
| ```bash | ||
| vcs import --input https://raw.githubusercontent.com/gazebo-tooling/gazebodistro/master/collection-rotary.yaml src/ | ||
| ``` | ||
|
|
||
| After the import, continue with the "Building the Gazebo Libraries" step | ||
| of the Jetty Windows source guide unchanged. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.