Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
65 lines (37 sloc) 2.17 KB

Klampt-jupyter-extension

This folder contains the Jupyter notebook extension for Klamp't.

If you installed Klamp't Python API from pip, you may prefer to install from the standalone Jupyter extension project because it is much lighter weight than downloading the full Klamp't source.

Installation

To make any use of this extension, you will need to install:

To install the extension, you can simply enter

sudo make install

in this directory.

For more control, you can use the following Makefile targets:

  • install-user: Installs this in the Jupyter user prefix
  • install-wurlitzer: The wurlitzer library for capturing C++ output in Python. This is not strictly needed, but is nice to have

Usage

The best way to learn how to use this extension is to study the example notebooks in the Jupyter subdirectory of the Klamp't examples package. Run:

git clone https://github.com/krishauser/Klampt-examples

And then launch Jupyter:

cd Klampt-examples/Jupyter

jupyter notebook

The Jupyter frontend widget can be created by a KlamptWidget, which is defined in the klampt.vis.ipython module. The module also contains useful helper widgets for editing robot configurations and points.

API documentation can be found found here.

Version history

0.2.0: matching to Klampt 0.8.0 release (12/31/2018)

  • Python interface is now in Klampt, not this module.
  • Widget state can be saved a bit more reliably.
  • API is closer to the klampt.vis module.

0.1.0: first release

Wish list

  • Saving standalone animations in HTML.
  • Camera resetting in the GUI.
  • More control over background color, lighting, textures.
  • Live editing in the visualization.

Contact

Author: Kris Hauser

Duke University

kris.hauser@duke.edu

You can’t perform that action at this time.