Installation Instructions

Dependencies

The meshpy module depends on the Berkeley AutoLab’s autolab_core and perception modules, which can be installed by following instructions in their respective repositories.

Rendering using meshpy also depends on OSMesa and Boost.NumPy, and compiling the renderer depends on CMake.

Any other dependencies will be installed automatically when meshpy is installed with pip.

Cloning the Repository

You can clone or download our source code from Github.

$ git clone git@github.com:BerkeleyAutomation/meshpy.git

Installation

Install OSMesa by running:

$ sudo apt-get install libosmesa6-dev

Install Boost.NumPy by cloning the latest stable repo:

$ git clone https://github.com/ndarray/Boost.NumPy.git

and following Boost-Numpy’s installation instructions.

Then to install meshpy in your current Python environment, simply change directories into the meshpy repository and run

$ pip install -e .

Alternatively, you can run

$ pip install /path/to/meshpy

to install meshpy from anywhere.

To visualize meshes, we highly recommend also installing the Berkeley AutoLab’s visualization module, which uses mayavi. This can be installed by cloning the repo:

$ git clone git@github.com:BerkeleyAutomation/visualization.git

and following installation instructions.

Testing

To test your installation, run

$ python setup.py test

We highly recommend testing before using the module.

Building Documentation

Building meshpy’s documentation requires a few extra dependencies – specifically, sphinx and a few plugins.

To install the dependencies required, simply run

$ pip install -r docs_requirements.txt

Then, go to the docs directory and run make with the appropriate target. For example,

$ cd docs/
$ make html

will generate a set of web pages. Any documentation files generated in this manner can be found in docs/build.

Deploying Documentation

To deploy documentation to the Github Pages site for the repository, simply push any changes to the documentation source to master and then run

$ . gh_deploy.sh

from the docs folder. This script will automatically checkout the gh-pages branch, build the documentation from source, and push it to Github.