From 6ee3e42d27dff96f0d5047d23ab9de89bff8b66d Mon Sep 17 00:00:00 2001 From: Frank Dellaert Date: Mon, 25 Jan 2016 00:09:51 -0800 Subject: [PATCH] Update README --- python/README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/python/README.md b/python/README.md index fc83ff702..f1c218cfb 100644 --- a/python/README.md +++ b/python/README.md @@ -3,16 +3,16 @@ 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 python files that compose the module are copied from python/gtsam to $BUILD_DIR/python/gtsam -* The handwritten module source files are then compiled and linked with Boost Python, generating a shared library which can then be imported by python -* The shared library is then copied to $BUILD_DIR/python/gtsam and renamed with a "_" prefix -* The user can use the setup.py script inside $BUILD_DIR/python to build and install a python package, allowing easy importing into a python project. Examples (when run from $BUILD_DIR): - * 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. - * python setup.py install --prefix="your/local/install/path"---- Installs the package into a local instalation folder. Can then be imported from any python file if _prefix_/lib/pythonX.Y/site-packages is present in your $PYTHONPATH -* To run the unit tests, you must first install the package on your path (TODO: Make this easier) +* 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 correspondent 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. +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. -TODO: There are many issues with this build system, but these are the basics.