Git Product home page Git Product logo

enki's Introduction

Enki

Enki is an open source robot simulator written in C++. It provides collision and limited physics support for robots evolving on a flat surface. On a contemporary desktop computer, Enki is able to simulate groups of robots hundred times faster than real-time.

© 1999-2017 Stéphane Magnenat and others (full list)

Supported robots

This section presents the robots available in the standard distribution, alongside their supported features. Enki is extensible: users can add their own custom robots.

Khepera

  • IR sensors
  • Linear camera
  • Wheel encoders

S-bot

  • Omnidirectional camera
  • Light ring
  • Simplified sound communication

Alice

  • IR sensors
  • IR communication
  • Linear camera

E-puck

  • IR sensors
  • Bluetooth communication
  • Linear camera
  • Scanner turret
  • Light ring
  • Wheel encoders

Thymio 2

  • IR proximity and ground sensors
  • 27 LEDs and realistically-textured hull
  • BackEMF speed meters

License

Enki is free software released under the GNU General Public License version 2. We kindly ask the authors of any publication arising from research using this software to add a reference to it as explained in the documentation.

Source distribution

This section explains how to compile Enki from the source distribution.

Prerequisites

To compile Enki and programs who depend on it, you need:

  • a working and fairly recent c++ compiler
  • CMake
  • A build environment compatible with CMake.

In addition, if you want the support for the viewer and Python bindings, you need:

Compilation under Unix

Those short instructions assume that you want to use "make" to build Enki. If you want to use another build environment, such as Microsoft Visual Studio, please refer to cmake documentation. Once you have downloaded and extracted the source distribution, you can create the Makefiles by running:

cmake .

and then build Enki by running:

make

You can also change the build options by running:

ccmake .

or

cmake-gui .

prior to cmake.

Use

To use the library with a project using CMake, add these lines in your project:

find_package(enki REQUIRED)

Then you can include the Enki directory with:

include_directories(${enki_INCLUDE_DIR})

And link to the library, and optionally its viewer, by:

target_link_libraries(YOUR_TARGET ${enki_VIEWER_LIBRARIES} ${enki_LIBRARY} ...)

Inside your code, include Enki and the viewer using:

#include <enki/PhysicalEngine.h>
#include <viewer/Viewer.h>

Documentation

HTML documentation (including examples and cookbooks) can be generated by the doc target of the build system. Doxygen tool can be downloaded from http://www.doxygen.org/

Contribute

If you want to contribute to Enki, please open an issue to discuss your idea or submit a pull request with a prototype.

Projects using Enki

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.