12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
gtsam/python
History
Ellon Mendes ffae37a675 Revert python module to use old handwritten files 
Just noticed several handwritten files here. I'm reverting the python module to
use these handwritten files to later add the files I was wrapping to the same
framework.

Classes from geometry were wrapped for an old C++ interface, so several
boost python's .def(...) were commented out.

Conflicts:
	python/gtsam/.gitignore
 		2015-12-02 13:35:15 +01:00
..
gtsam Revert python module to use old handwritten files 2015-12-02 13:35:15 +01:00
gtsam_tests Reworked python directory structure. Added readme on constructing python module. Added first unit test for point2. Everything needed to get it passing is also here, including some renaming of variables and emitted library names 2015-12-02 13:35:14 +01:00
handwritten Revert python module to use old handwritten files 2015-12-02 13:35:15 +01:00
CMakeLists.txt Revert python module to use old handwritten files 2015-12-02 13:35:15 +01:00
README.md Markdown readme 2015-12-02 13:35:14 +01:00
setup.py Reworked python directory structure. Added readme on constructing python module. Added first unit test for point2. Everything needed to get it passing is also here, including some renaming of variables and emitted library names 2015-12-02 13:35:14 +01: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.

  • Wrap parses gtsam.h and constructs a cpp file called ${moduleName}_python.cpp
  • This file is then compiled and linked with BoostPython, generating a shared library which can then be imported by python
  • The shared library is then copied to python/gtsam
  • The user can use the setup.py script to build and install a python package, allowing easy importing into a python project. Examples:
    • python setup.py sdist ---- Builds a tarball of the python package which can then be distributed
    • python setup.py install ---- Installs the package into the python dist-packages folder. Can then be imported from any python file.
  • To run the unit tests, you must first install the package on your path (TODO: Make this easier)

TODO: There are many issues with this build system, but these are the basics.