Installation

Next Tutorial: Profiler

These instructions are for installing only Ignition Common. 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.

Binary Installation

Ubuntu

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

sudo apt install libignition-common<#>-dev

Be sure to replace <#> with a number value, such as 2 or 3, 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 Ignition Common:

brew install ignition-common<#>

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

Windows

Install Conda package management system. Miniconda suffices.

Create if necessary, and activate a Conda environment:

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

Install ignition-common:

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

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

Source Installation

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

Prerequisites

Ignition Common requires:

• Ignition CMake
• Ignition Math.

The Graphics component requires:

• FreeImage
• GTS.

The AV component requires:

• libswscale
• libavdevice
• libavformat
• libavcodec
• libavutil

Windows

First, follow the ign-cmake tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and 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).

Activate the Conda environment:

conda activate ign-ws

Install prerequisites:

conda install freeimage gts glib dlfcn-win32 ffmpeg --channel conda-forge

Install Ignition dependencies:

You can view available versions and their dependencies:

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

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

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

Build from Source

Ubuntu

1. Clone the repository

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

2. Configure and build

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

3. Optionally, install

   sudo make install

macOS

1. Clone the repository

   git clone https://github.com/ignitionrobotics/ign-common -b ign-common<#>

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

   brew install --only-dependencies ignition-common<#>

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

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

4. Optionally, install

   sudo make install

Windows

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

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

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

2. Configure and build

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

3. Optionally, install

   cmake --install . --config Release

Documentation

API and tutorials can be found at https://ignitionrobotics.org/libs/common.

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-common

3. Configure and build the documentation.

   cd ign-common
   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

Testing

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

1. Follow the source install instruction.
2. Run tests.

   make test

3. Static code checker.

   make codecheck