Next Tutorial: Profiler
These instructions are for installing only Gazebo Common. If you're interested in using all the Gazebo libraries, check out this Gazebo 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 gz-common
:
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:
Install Gazebo 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:
Install gz-common
:
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
Gazebo Common requires:
The Graphics component requires:
The AV component requires:
The Geospatial component requires:
Windows
First, follow the gz-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:
Install prerequisites:
Install Gazebo dependencies:
You can view available versions and their dependencies:
Install dependencies, replacing <#>
with the desired versions:
Build from Source
Ubuntu
- Clone the repository git clone https://github.com/gazebosim/gz-common
- Configure and build cd gz-commonmkdir buildcd buildcmake ..make
- Optionally, install sudo make install
macOS
- Clone the repository Be sure to replacegit clone https://github.com/gazebosim/gz-common -b gz-common<#>
<#>
with a number value, such as 3 or 4, depending on which version you need. From version 5 usegz-common<#>
for lower versions useign-common<#>
. - Install dependencies Be sure to replacebrew install --only-dependencies gz-common<#>
<#>
with a number value, such as 3 or 4, depending on which version you need. - Configure and build cd gz-commonmkdir buildcd buildcmake ..make
- Optionally, install sudo make install
Windows
This assumes you have created and activated a Conda environment while installing the Prerequisites.
- Navigate to where you would like to build the library, and clone the repository. # Optionally, append `-b gz-common#` (replace # with a number) to check out a specific version.# From version 5 use `gz-common<#>` for lower versions use `ign-common<#>`.git clone https://github.com/gazebosim/gz-common.git
- Configure and build cd gz-commonmkdir buildcd buildcmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\installcmake --build . --config Release
- Optionally, install cmake --install . --config Release
Documentation
API and tutorials can be found at https://gazebosim.org/libs/common.
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-common
- Configure and build the documentation. cd gz-commonmkdir buildcd buildcmake ../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