| Linux/OS X | Windows |
|---|---|
 |
|
| The CoDyCo project is a four-years long project that started in March 2013. At the end of each year a scenario will be used to validate on the iCub the theoretical advances of the project. |
More info at http://codyco.eu/
Code documentation automatically generated: http://wiki.icub.org/codyco/dox/html/index.html
This is a meta repository (so-called "superbuild") that uses YCM to compile CoDyCo software. A YCM Superbuild is a CMake project whose only goal is to download and build several other projects. You can read more about the superbuild concept in YCM documentation.
codyco-superbuild will download and build a number of projects, divided in components.
For each project, the repository will be downloaded in the component/project subdirectory
of the superbuild root. The build directory for a given project will be instead the component/project subdirectory
of the superbuild build directory.
###external
The external component contains software not developed inside the CoDyCo consortium, but that is a dependency of CoDyCo software.
###libraries
The libraries component contains librares developed by the CoDyCo consortium, that could be used also by external software.
The projects downloaded in the libraries component are:
codyco-commons: A collection of functions and utilities used in the other projectsidyntree: YARP-based Floating Base Robot Dynamics LibraryparamHelp: Library for simplifying the management of the parameters of YARP moduleswholebodyinterface: C++ Interfaces to sensor measurements, state estimations, kinematic/dynamic model and actuators for a floating base robotyarp-wholebodyinterface: Implementation of the wholeBodyInterface for YARP robotsorocosBFLBerdy: Fork of the Bayesian Filtering Library Orocos-BFL. Early stage. Currently used and tested only for the quaternionEKF module and basic Kalman FilteringEigenLgsm: Lie group solid mechanics header library for Eigen.ocra-recipes: Optimization based Control for Robotics Applications. A set of libraries designed to efficiently formulate robot control problems as a convex optimization problems.
###main
The main component contains executable software developed by the CoDyCo consortium, for example YARP modules,
Simulink models or Lua scripts.
The projects downloaded in the main component are:
WB-Toolbox 2.0: Simulink Toolbox for rapid prototyping of Whole Body Robot Controllers.codyco-modules: YARP modules and controllers developed within the European Project CoDyCo.ocra-wbi-plugins: Interface between the whole-body controller libraries (ocra-recipes) developed at ISIR and WBI. To compile these libraries and modules, enable the option:CODYCO_BUILD_OCRA_MODULES : ON.
The gazebo-yarp-plugins, that are usually used for testing CoDyCo software simulating the iCub in Gazebo, are not installed by the codyco-superbuild. If you want to simulate the iCub in Gazebo you have to follow the instruction in gazebo-yarp-plugins README.
We provide different instructions on how to install codyco-superbuild, depending on your operating system:
- Windows: use the superbuild with Microsoft Visual Studio
- OS X: use the superbuild with Xcode or GNU make
- Linux: use the superbuild with make
Complete documentation on YCM documentation
##Linux
###System Dependencies
On Debian based systems (as Ubuntu) you can install the C++ toolchain, Git, CMake and Eigen (and other dependencies necessary for the codyco-superbuild) using apt-get:
sudo apt-get install libeigen3-dev build-essential cmake cmake-curses-gui libboost-system-dev libboost-filesystem-dev libboost-thread-dev libtinyxml-dev libace-dev libgtkmm-2.4-dev libglademm-2.4-dev libgsl0-dev libcv-dev libhighgui-dev libcvaux-dev libode-dev liblua5.1-dev lua5.1 git swig
The packages provided in the official distro repositories work out of the box for Ubuntu 14.04 (trusty), Ubuntu 13.10 (saucy) and Debian 8 (jessie).
For older distros the included CMake and Eigen are too old, and is necessary to find a way to install them from an alternative
source:
- In Debian 7 (
wheezy) it is sufficient to enable thewheezy-backportsrepository and install the recent versions of CMake and Eigen provided in it:
sudo apt-get -t wheezy-backports install cmake libeigen3-dev
- In Ubuntu 12.04 (
precise) a PPA is available to easily install CMake 2.8.12. To install a recent version of Eigen the easiest solution is to get Eigen from source.
For installing the latest version of YARP and ICUB software, please refer to the official iCub documentation. Please note that at the moment the codyco-superbuild only supports YARP and ICUB installed from sources.
If you don't know what orocos-bfl-berdy is, it is safe for you to skip this section
When enabling the flag CODYCO_USES_OROCOS_BFL_BERDY, the library Orocos-BFL-BERDY is compiled and modules such as quaternionEKF enabled in codyco-modules. If you want to use the latter, besides Orocos-BFL-BERDY you will also need to set the environmental variable PKG_CONFIG_PATH as:
export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:$CODYCO_SUPERBUILD_ROOT/build/install/lib/pkgconfig/
And as an additional dependency of codyco-superbuild you will also have: libboost-iostreams-dev.
###Superbuild If you didn't already configured your git, you have to set your name and email to sign your commits:
git config --global user.name FirstName LastName
git config --global user.email [email protected]
Finally it is possible to install CoDyCo software using the YCM superbuild:
git clone https://github.com/robotology/codyco-superbuild.git
cd codyco-superbuild
mkdir build
cd build
ccmake ../
make###Configure your environment
Currently the YCM superbuild does not support building a global install target, so all binaries are installed in codyco-superbuild/build/install/bin and all libraries in codyco-superbuild/build/install/lib.
To use this binaries and libraries, you should update the PATH and LD_CONFIG_PATH environment variables.
An easy way is to add this lines to the '.bashrc` file in your home directory:
export CODYCO_SUPERBUILD_ROOT=/directory/where/you/downloaded/codyco-superbuild
export PATH=$PATH:$CODYCO_SUPERBUILD_ROOT/build/install/bin
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CODYCO_SUPERBUILD_ROOT/build/install/lib
export YARP_DATA_DIRS=$YARP_DATA_DIRS:$CODYCO_SUPERBUILD_ROOT/build/install/share/codyco
To use the updated .bashrc in your terminal you should run the following command:
user@host:~$ source ~/.bashrcIf may also be necessary to updates the cache of the dynamic linker:
user@host:~$ sudo ldconfig##OS X
###System Dependencies To install Eigen and CMake, it is possible to use Homebrew:
brew install eigen cmake boost tinyxml
For installing the latest version of YARP and ICUB software, please refer to the official iCub documentation.
###Superbuild If you didn't already configured your git, you have to set your name and email to sign your commits:
git config --global user.name FirstName LastName
git config --global user.email [email protected]
Finally it is possible to install CoDyCo software using the YCM superbuild:
git clone https://github.com/robotology/codyco-superbuild.git
cd codyco-superbuild
mkdir build
cd buildTo use GNU Makefile generators:
cmake ../
makeTo use Xcode project generators
cmake ../ -G Xcode
xcodebuild -configuration Release###Configure your environment
Currently the YCM superbuild does not support building a global install target, so all binaries are installed in codyco-superbuild/build/install/bin and all libraries in codyco-superbuild/build/install/lib.
To use this binaries you should update the PATH environment variables.
An easy way is to add these lines to the .bashrc or .bash_profile file in your home directory:
CODYCO_SUPERBUILD_ROOT=/directory/where/you/downloaded/codyco-superbuild
export PATH=$PATH:$CODYCO_SUPERBUILD_ROOT/build/install/bin
export YARP_DATA_DIRS=$YARP_DATA_DIRS:$CODYCO_SUPERBUILD_ROOT/build/install/share/codycoMost of the modules in the codyco-superbuild are correctly configured to automatically find the libraries.
If you create a new application or library that need to be linked to codyco-superbuild libraries (or if you are having issues with the dynamic loader) add also the following line to your .bashrc or .bash_profile.
export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$CODYCO_SUPERBUILD_ROOT/build/install/libTo use the updated .bashrc in your terminal you should run the following command:
user@host:~$ source ~/.bashrcor for the .bash_profile file
user@host:~$ source ~/.bash_profileor simply open a new terminal.
##Windows
While the software developed in the CoDyCo project is tested to be compatible with Windows, the Gazebo simulator that we use as a simulation platform does not support Windows. For this reason if you plan to do use the CoDyCo software with the Gazebo simulator, for the time being it is easier for you to use Linux or OS X.
###System Dependencies Most of the CoDyCo software is developed using the C/C++ language. For this reason, you should have Visual Studio installed on your computer to build it. In particular we install some dependencies of our software we rely on the binary installers provided by the official iCub software. As this binaries are still not available for Visual Studio 2015, we recommend to use Visual Studio 2013 to compile the CoDyCo software.
You will also need some additional software, as listed afterwards. Some of this software can be easily installed using Chocolatey, a tool to simplify software installation on Windows.
####Git Most of the CoDyCo software is hosted on Git repositories, so you will need Git to download them. You can download the Git installer at http://msysgit.github.io/ .
If you have installed Chocolatey, you can install Git with the following command:
choco install git
####Mercurial
Some software required by the codyco-superbuild (namely the Eigen library) are hosted in Mercurial repositories, so you will need Mercurial to automatically download them.
You can download the Mercurial installer at http://mercurial.selenic.com/wiki/Download .
If you have installed Chocolatey, you can install Monotone with the following command:
choco install hg
####CMake To install CMake you can use the official installer available at http://www.cmake.org/cmake/resources/software.html . It is recommended to install the latest version of CMake.
If you have installed Chocolatey, you can install CMake with the following command:
choco install cmake
####Eigen Eigen can be automaically installed with the codyco-superbuild, so you don't have to install it manually.
If you want to install Eigen manually, or you have already installed Eigen please check the following section.
You can install Eigen from source code available from the Eigen official website.
You can simply extract the Eigen source code in a directory, and then define the EIGEN3_ROOT environment variable to the path of the directory that contains the file signature_of_eigen3_matrix_library (it should be the first directory contained in the compressed file).
####Boost
Some software of codyco-superbuild requires Boost. If you have already a copy of the Boost libraries
installed on your system, you can use them for compiling codyco-superbuild by defining the appropriate
BOOST_DIR, BOOST_LIBRARYDIR and BOOST_INCLUDEDIR enviroment variables.
####YARP & iCub For installing the latest version of YARP and ICUB software, please refer to the official iCub documentation.
###Superbuild If you didn't already configured your git, you have to set your name and email to sign your commits:
git config --global user.name FirstName LastName
git config --global user.email [email protected]
After that you can clone the superbuild repository as any other git repository, and generate the Visual Studio solution using the CMake gui. Then you open the generated solution with Visual Studio and build the target all.
Visual Studio will then download, build and install in a local directory all the CoDyCo software and its dependencies.
If you prefer to work from the command line, you can also compile the all target using the following command (if you are in the codyco-superbuild/build directory:
cmake --build .
###Configure your environment
Currently the YCM superbuild does not support building a global install target, so all binaries are installed in codyco-superbuild/build/install/bin and all libraries in codyco-superbuild/build/install/lib.
To use this binaries and libraries, you should update the necessary environment variables.
Set the environment variable CODYCO_SUPERBUILD_ROOT so that it points to the directory where you clone the codyco-superbuild repository.
Append $CODYCO_SUPERBUILD_ROOT/build/install/bin to your PATH
Append $CODYCO_SUPERBUILD_ROOT/build/install/share/codyco to your YARP_DATA_DIRS environment variable.
For updating the codyco-superbuild repository it is possible to just fetch the last changes using the usual git command:
git pull
However, for running the equivalent of git pull on all the repositories managed by
the codyco-superbuild, you have to execute in your build system the appropriate target.
To do this, make sure to be in the build directory of the codyco-superbuild and execute:
make update-all
on Linux or
cmake --build . --target UPDATE_ALL
on Windows or
cmake --build . --target ALL_UPDATE
on Mac OS X
If MATLAB is installed on your computer, the codyco-superbuild can install some libraries that depend on MATLAB, in particular:
- MATLAB bindings of the iDynTree library.
- MATLAB bindings of the qpOASES library.
- The WB-Toolbox Simulink toolbox.
To use this software, you can simply enable its compilation using the CODYCO_USES_MATLAB CMake option.
Once this software has been compiled by the superbuild, you just need to add some directories of the codyco-superbuild install (typically $CODYCO_SUPERBUILD_ROOT/build/install) to the MATLAB path.
In particular you need to add to the MATLAB path the $CODYCO_SUPERBUILD_ROOT/build/install/mex directory and all the subdirectories $CODYCO_SUPERBUILD_ROOT/build/install/share/WB-Toolbox.
As an example, you could add this line to your MATLAB script that uses the codyco-superbuild matlab software:
addpath(['codyco_superbuild_install_folder' /mex])
addpath(genpath(['codyco_superbuild_install_folder' /share/WB-Toolbox]))
Anyway we strongly suggest that you add this directories to the MATLAB path in robust way,
for example by modifyng the startup.m or the MATLABPATH enviromental variable as described in official MATLAB documentation
For more info on configuring MATLAB software with the codyco-superbuild, please check the WB-Toolbox README.
Note: the legacy WBI-Toolbox 1.0 (old version of WB-Toolbox) is still enabled by the CODYCO_USES_WBI_TOOLBOX flag, but is going to be removed from the codyco-superbuild on June 1st 2016.
Please update your Simulink controllers using the the migration guide from WBI-Toolbox 1.0.
MATLAB controllers developed in the CoDyCo project are available in the WBI-Toolbox-controllers repository.
Given that some users want to fully control this repository, it is not downloaded automically if you select the CODYCO_USES_MATLAB option. To download this repository as part of the superbuild, just enable the CODYCO_USES_WBI_TOOLBOX_CONTROLLERS CMake option.