Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.53 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.53 KB
Raw

KhepPy

KhepPy stands for Khepera Python and is Python API with evolutionary computation and reinforcement learning algorithms for Khepera simulation engine. More information about the engine itself can be found here.

The idea behind KhepPy is to provide algorithms able to generate high-quality steering programs for Khepera robots.

Install

Install the latest release

  • from PyPi: pip install kheppy
  • or directly from GitHub: pip install git+https://github.com/Ewande/kheppy

Khepera simulation engine binaries

Build from source: project page.
Or use precompiled binaries:

  • Linux (tested on Ubuntu 14.04)
  • OS X/macOS (tested on macOS Sierra/High Sierra)
  • Windows (tested on Windows 7/8)

And configure KHEPERA_LIB environment variable to point to the Khepera simulation engine binaries.

export KHEPERA_LIB="/your/path/to/the/engine"

Test installation

For basic verification run:

python -c 'from kheppy.core import Simulation'

No output means kheppy.core should be ready to use.

Examples

Now you can run some examples to familiarize yourself with KhepPy.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details