Install

These instructions are for installing only Gazebo Launch. If you're interested in using all the Gazebo libraries, not only Igniton Launch, check out this Gazebo installation.

We recommend following the binary install instructions to get up and running as quickly and painlessly as possible.

The source install instructions should be used if you need the very latest software improvements, if you need to modify the code, or if you plan to make a contribution.

Binary Install

We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible.

The Source Install instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.

Ubuntu 20.04 or above

On Ubuntu systems, apt can be used to install gz-launch:

sudo apt install libgz-launch<#>

Be sure to replace <#> with a number value, such as 1 or 2, depending on which version you need.

macOS

On macOS, add OSRF packages:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

brew tap osrf/simulation

Install Gazebo GUI:

brew install gz-launch<#>

Be sure to replace <#> with a number value, such as 4 or 5, depending on which version you need.

Source Install

Ubuntu 20.04 or above

Source installation can be performed in UNIX systems by first installing the necessary prerequisites followed by building from source.

Prerequisites

Ubuntu Focal or higher

Install third-party libraries:

``` sudo apt -y install \ $(sort -u $(find . -iname 'packages-'lsb_release -cs'.apt' -o -iname 'packages.apt' | grep -v '/.git/') | sed '/ignition|sdf/d' | tr '
' ' ') ```

Install required Gazebo libraries

``sh sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable</tt>lsb_release -cs‘ main" > /etc/apt/sources.list.d/gazebo-stable.list’ wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add - sudo apt-get update sudo apt-get -y install libgz-cmake3-dev libgz-sim2-dev ```

Building from source


Clone the repository
```sh git clone https://github.com/gazebosim/gz-launch ```

Configure and build
```sh cd gz-launch; mkdir build; cd build; cmake ..; make ```

Optionally, install Gazebo Launch
```sh sudo make install ```

macOS


Clone the repository 
git clone https://github.com/gazebosim/gz-launch -b ign-launch<#>
Be sure to replace <#> with a number value, such as 4 or 5, depending on which version you need.

Install dependencies 
brew install --only-dependencies ignition-launch<#>
Be sure to replace <#> with a number value, such as 5 or 6, depending on which version you need.

Configure and build cd gz-launch
mkdir build
cd build
cmake ..
make

Optionally, install sudo make install

Documentation

API and tutorials can be found at https://gazebosim.org/libs/launch.

You can also generate the documentation from a clone of this repository by following these steps.


You will need Doxygen. On Ubuntu Doxygen can be installed using
``` sudo apt-get install doxygen ```

Clone the repository
``` git clone https://github.com/gazebosim/gz-launch ```

Configure and build the documentation.
``` cd gz-launch; mkdir build; cd build; cmake ../; make doc ```

View the documentation by running the following command from the build directory.
``` firefox doxygen/html/index.html ```

Testing

Follow these steps to run tests and static code analysis in your clone of this repository.


Follow the source install instruction.
Run tests.
``` make test ```

Static code checker.
``` make codecheck ```