Khepera III Toolbox/Download and Installation

From Wikibooks, open books for an open world
Jump to navigation Jump to search

Download[edit | edit source]

Downloading the Package[edit | edit source]

A more or less stable release of the toolbox is now available on the sourceforge project page. After downloading the file, uncompress it with

unzip khepera3toolbox-YYYY-MM-DD.zip

This will create a folder khepera3toolbox in your current directory with the whole toolbox.

This is the preferred way of getting the toolbox if you intend to just use it, but not make any contributions (programs, modules, bugfixes, ...) by yourself. Whenever we release a new version, you have to download a new ZIP file, and replace the whole khepera3toolbox with the new version of the toolbox.


Getting the Latest Revision from SVN[edit | edit source]

The latest version can be obtained by checking out the following SVN tree:

svn checkout https://svn.code.sf.net/p/khepera3toolbox/code/

This will create a folder khepera3toolbox in your current directory with the whole toolbox.

This is the preferred way of getting the toolbox if you plan on making contributions (programs, modules, bugfixes, ...) by yourself, or if you want to use the latest version of the toolbox. To update to a new revision, just type

svn update

inside the khepera3toolbox folder.

Installation[edit | edit source]

The toolbox does not need to be copied to a specific place - it stays in a convenient place in your home directory.

However, you need to modify two environment variables. This can either be done manually, by typing the following two lines on your bash shell:

export K3_ROOT=/path/to/your/khepera3toolbox
export PATH=$PATH:$K3_ROOT/Scripts

or automatically, by adding the above lines to your ~/.bashrc (or ~/.profile) file. Note that if you choose to do it manually, you need to it each time you open a new terminal window.

To check if you set these variables correctly, type

k3go -h

This should print a short help text for the k3go script in your terminal window.