Installation

These instructions are for installing only Ignition Plugin. If you're interested in using all the Ignition libraries, check out this Ignition installation.

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

The Source Installation 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

Prerequisites

Ignition Plugin version 1 requires Ubuntu Bionic, while version 0 can be used with Ubuntu Xenial.

If you don't already have the lsb-release package installed, please do so now:

sudo apt-get update
sudo apt-get install lsb-release

Setup your computer to accept software from packages.osrfoundation.org:

sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'

Setup keys:

wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -

Binary Installation

On Ubuntu systems, apt-get can be used to install ignition-plugin:

sudo apt-get update
sudo apt install libignition-plugin-dev

Source Installation

1. Install required Ignition dependencies

   sudo apt-get install libignition-cmake2-dev

1. Install Ignition Tools if you want to use the ign plugin command line tool:

     sudo apt-get install ignition-tools
   
   2. Clone the repository
     ```bash
     git clone https://github.com/ignitionrobotics/ign-plugin

2. Configure and build

   cd ign-plugin
   mkdir build
   cd build
   cmake ..
   make

3. Optionally, install

   sudo make install

macOS

Prerequisites

Ignition Plugin and several of its dependencies can be installed on macOS with Homebrew using the osrf/simulation tap. Ignition Plugin version 1 requires macOS High Sierra (10.13) or later, while version 0 supports Sierra (10.12) or later.

Binary Installation

1. Install Homebrew, which should also prompt you to install the XCode command-line tools

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

2. Run the following commands

   brew tap osrf/simulation
   brew install ignition-plugin1

Source Installation

1. Install dependencies

   brew tap osrf/simulation
   brew install ignition-plugin1 --only-dependencies

2. Clone the repository

   git clone https://github.com/ignitionrobotics/ign-plugin

3. Configure and build

   cd ign-plugin
   mkdir build
   cd build
   cmake ..
   make

4. Optionally, install

   sudo make install

Windows

Prerequisites

First, follow the ign-cmake tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment.

Navigate to condabin if necessary to use the conda command (i.e., if Conda is not in your PATH environment variable. You can find the location of condabin in Anaconda Prompt, where conda).

Create if necessary, and activate a Conda environment:

conda create -n ign-ws
conda activate ign-ws

Binary Installation

conda install libignition-plugin<#> --channel conda-forge

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

Source Installation

This assumes you have created and activated a Conda environment while installing the Prerequisites.

1. Install Ignition dependencies:

   You can view available versions and their dependencies:

   conda search libignition-plugin* --channel conda-forge --info

   Install dependencies, replacing <#> with the desired version:

   conda install libignition-cmake<#> --channel conda-forge

2. Navigate to where you would like to build the library, and clone the repository.

   # Optionally, append `-b ign-plugin#` (replace # with a number) to check out a specific version
   git clone https://github.com/ignitionrobotics/ign-plugin

3. Configure and build

   cd ign-plugin
   mkdir build
   cd build
   cmake .. -DBUILD_TESTING=OFF  # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
   cmake --build . --config Release

4. Optionally, install

   cmake --install . --config Release

Documentation

API documentation and tutorials can be accessed at Ignition Robotics website

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

1. You will need Doxygen. On Ubuntu Doxygen can be installed using

   sudo apt-get install doxygen

2. Clone the repository

   git clone https://github.com/ignitionrobotics/ign-plugin

3. Configure and build the documentation.

   cd ign-plugin
   mkdir build
   cd build
   cmake ..
   make doc

4. View the documentation by running the following command from the build directory.

   firefox doxygen/html/index.html

Note Alternatively, documentation for ignition-plugin can be found within the source code, and also in the MIGRATION.md guide.

Test

Run tests as follows:

make test

Tests are automatically built. To disable them, run cmake as follows:

cmake .. -DBUILD_TESTING=false

Test coverage

To run test coverage:

1. Install LCOV

sudo apt-get install lcov

1. Build with coverage

cd build/
cmake .. -DCMAKE_BUILD_TYPE=coverage
make

1. Run tests

   make test

2. Generate coverage

   make coverage

3. View results

   firefox coverage/index.html