[Documentation] [TitleIndex] [WordIndex

Conceptual Overview

See catkin/conceptual_overview

Installing catkin

Catkin is included by default when ROS is installed. Catkin can also be installed from source or prebuilt packages. Most users will want to use the prebuilt packages, but installing it from source is also quite simple.

Install from source

Catkin has the following dependencies:

  • CMake - A cross-platform, open-source build system.

  • Python - Python is a general-purpose, interpreted high-level programming language. Version 2.7 is required (reference).

    • catkin_pkg - A Python runtime library for catkin.

    • empy - A Python template library.

    • nose - A Python testing framework.

  • GTest - A cpp unittest framework from Google.

  • GNU C++ Compiler (g++) - The GNU C++ compiler

You can resolve these dependencies on Ubuntu with this command:

sudo apt-get install cmake python-catkin-pkg python-empy python-nose python-setuptools libgtest-dev build-essential

If you are not on Ubuntu you can install catkin_pkg from PyPi via pip.

If you have trouble installing the python-* packages in the command above, make sure you have added the packages.ros.org debian repository to your apt source lists as described on this page.

Then install catkin like any CMake package

mkdir build && cmake ../ && make && sudo make install

Note: You usually want to pass a specific build type when invoking CMake, e.g. cmake -DCMAKE_BUILD_TYPE=Release ../ (or RelWithDebInfo / Debug instead of Release, see http://cmake.org/cmake/help/v2.8.12/cmake.html#variable:CMAKE_BUILD_TYPE).

Install prebuilt package

If you are using a ROS binary distribution (Groovy or higher) on Ubuntu then you can install catkin with apt-get:

sudo apt-get install ros-groovy-catkin

sudo apt-get install ros-hydro-catkin

Most ROS installations will include this by default.

Note for ROS Fuerte Users: An experimental version of catkin was released with ROS Fuerte that is quite different from the version in Groovy. Those using ROS Fuerte should continue utilizing rosbuild.

Migrating from rosbuild

See catkin/migrating_from_rosbuild

External Documentation

See the external catkin docs containing:


Configuration File References

Glossary of Terms

See catkin/Glossary


Code Reviews

Are you looking for the ROS Groovy documentation for catkin?

catkin was in alpha for ROS Fuerte, please see the ROS Groovy documentation for catkin if you want to see the new usage.

ROS Fuerte catkin documentation: catkin docs (Fuerte)

Not supported, use rosbuild.

Report a Bug

GitHub ros/catkin

2024-06-15 12:54