gtsam/python
dellaert ad54d7805c Return value, not const reference 2016-04-10 18:30:41 -07:00
..
gtsam Many small improvements, bug-fixes, and tests 2016-02-24 11:01:19 -08:00
gtsam_examples Many small improvements, bug-fixes, and tests 2016-02-24 11:01:19 -08:00
gtsam_tests ScenarioRunner wrapped and tested 2016-01-26 17:37:23 -08:00
gtsam_utils Many small improvements, bug-fixes, and tests 2016-02-24 11:01:19 -08:00
handwritten Return value, not const reference 2016-04-10 18:30:41 -07:00
include/numpy_eigen Moved numpy_eigen headers to a more logical place 2016-01-28 16:47:12 -08:00
.gitignore Fix python instalation using distutils 2015-12-02 13:35:16 +01:00
CMakeLists.txt Moved numpy_eigen headers to a more logical place 2016-01-28 16:47:12 -08:00
README.md Update README 2016-01-25 00:09:51 -08:00
setup.py.in Another attempt at fixing installation of _libgtsam_python.so. package_data is relative to package_dir, so the previous approach doesn't work when package_dir is in the source tree (and we don't want to copy the lib to source, or all of the source into lib). Using data_files method instead. 2016-01-24 23:22:40 -05:00

README.md

Python Wrapper and Packaging

This directory contains the basic setup script and directory structure for the gtsam python module. During the build of gtsam, when GTSAM_BUILD_PYTHON is enabled, the following instructions will run.

  • The handwritten module source files are compiled and linked with Boost Python, generating a shared library which can then be imported by python
  • A setup.py script is configured from setup.py.in
  • The gtsam packages 'gtsam', 'gtsam_utils', 'gtsam_examples', and 'gtsam_tests' are installed into the site-packages folder within the (possibly non-default) installation prefix folder. If installing to a non-standard prefix, make sure that prefix/lib/pythonX.Y/site-packages is present in your $PYTHONPATH

The target version of Python to create the module can be set by defining GTSAM_PYTHON_VERSION to 'X.Y' (Example: 2.7 or 3.4), or 'Default' if you want to use the default python installed in your system. Note that if you specify a target version of python, you should also have the correspondening Boost Python version installed (Example: libboost_python-py27.so or libboost_python-py34.so on Linux). If you're using the default version, your default Boost Python library (Example: libboost_python.so on Linux) should correspond to the default python version in your system.