diff --git a/harmonic/index.yaml b/harmonic/index.yaml index c98c21ff2..e10bf44fc 100644 --- a/harmonic/index.yaml +++ b/harmonic/index.yaml @@ -20,6 +20,15 @@ pages: file: install.md description: Harmonic installation instructions children: + - name: install_ubuntu + title: Binary Ubuntu Install + file: install_ubuntu.md + - name: install_osx + title: Binary macOS Install + file: install_osx.md + - name: install_windows + title: Binary Windows Install + file: install_windows.md - name: install_ubuntu_src title: Ubuntu Source Install file: install_ubuntu_src.md diff --git a/harmonic/install_osx.md b/harmonic/install_osx.md new file mode 100644 index 000000000..a8870bf1e --- /dev/null +++ b/harmonic/install_osx.md @@ -0,0 +1,35 @@ +# Binary Installation on MacOS + +All the Harmonic binaries are available in Catalina and BigSur using the +[homebrew package manager](https://brew.sh/). + +The homebrew tool can be installed using: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" +``` + +After installing the homebrew package manager, Gazebo Harmonic can be installed running: + +```bash +brew tap osrf/simulation +brew install gz-harmonic +``` + +All libraries should be ready to use and the `gz sim -s` server app ready to be executed. + +Head back to the [Getting started](/docs/all/getstarted) +page to start using Gazebo! + +## Uninstalling binary install + +If you need to uninstall Gazebo or switch to a source-based install once you +have already installed the library from binaries, run the following command: + +```bash +brew uninstall gz-harmonic +``` + +## Troubleshooting + +See [Troubleshooting](/docs/harmonic/troubleshooting#macos) diff --git a/harmonic/install_ubuntu.md b/harmonic/install_ubuntu.md new file mode 100644 index 000000000..dc51966a4 --- /dev/null +++ b/harmonic/install_ubuntu.md @@ -0,0 +1,44 @@ +# Binary Installation on Ubuntu + +Harmonic pre-release binaries are provided for Ubuntu Jammy. The +Harmonic binaries are hosted in the packages.osrfoundation.org repository. +To install all of them, the metapackage `gz-harmonic` can be installed. + +**WARNING:** `gz-harmonic` cannot be installed alongside gazebo-classic (eg. `gazebo11`) since both use the `gz` command line tool. Trying to install `gz-harmonic` on a system that already has gazebo-classic installed from binaries will cause gazebo-classic and its dependencies to be uninstalled. Currently, the workarounds for this are to install from source or to use Docker [`gazebo-classic`](https://hub.docker.com/_/gazebo) so they are not installed side-by-side on the same system. + +First install some necessary tools: + +```bash +sudo apt-get update +sudo apt-get install lsb-release wget gnupg +``` + +Then install Gazebo Harmonic: + + +```bash +sudo wget https://packages.osrfoundation.org/gazebo.gpg -O /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-stable $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/gazebo-stable.list > /dev/null +echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/pkgs-osrf-archive-keyring.gpg] http://packages.osrfoundation.org/gazebo/ubuntu-prerelease $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/gazebo-prerelease.list > /dev/null +sudo apt-get update +sudo apt-get install gz-harmonic +``` + +All libraries should be ready to use and the `gz sim` app ready to be executed. + +Head back to the [Getting started](/docs/all/getstarted) +page to start using Gazebo! + + +## Uninstalling binary install + +If you need to uninstall Gazebo or switch to a source-based install once you +have already installed the library from binaries, run the following command: + +```bash +sudo apt remove gz-harmonic && sudo apt autoremove +``` + +## Troubleshooting + +See [Troubleshooting](/docs/harmonic/troubleshooting#ubuntu) diff --git a/harmonic/install_windows.md b/harmonic/install_windows.md new file mode 100644 index 000000000..f0aacc753 --- /dev/null +++ b/harmonic/install_windows.md @@ -0,0 +1,72 @@ +