12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

release/4.3a0
Duy-Nguyen Ta 2017-07-24 03:54:35 -04:00
parent 32ac96ea18
commit de74406d0d
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
cython/README.md
View File

@ -8,25 +8,23 @@ INSTALL
pip install -r <gtsam_folder>/cython/requirements.txt pip install -r <gtsam_folder>/cython/requirements.txt
``` ```
- It also needs Eigency, a package that interfaces between C++'s Eigen and Python's numpy. - It also needs [Eigency](https://github.com/wouterboomsma/eigency.git), a package that interfaces between C++'s Eigen and Python's numpy.
You can try to install via pip: "pip install eigency". If that fails, please install it from source as follows: For compatiblity with gtsam's Eigen version, it contains its own version of eigency.
```bash If you have eigency installed in your system and insist on using it,
git clone https://github.com/wouterboomsma/eigency.git make sure your eigency's Eigen version and gtsam's Eigen version are the same
cd eigency and set the option GTSAM_USE_SYSTEM_EIGENCY in CMake to ON (OFF by default) before building.
python setup.py -v build
python setup.py install
```
- Build and install gtsam using cmake with GTSAM_INSTALL_CYTHON_TOOLBOX enabled. The wrapped module will be installed to GTSAM_CYTHON_INSTALL_PATH, which is - Build and install gtsam using cmake with GTSAM_INSTALL_CYTHON_TOOLBOX enabled.
The wrapped module will be installed to GTSAM_CYTHON_INSTALL_PATH, which is
by default: <your CMAKE_INSTALL_PREFIX>/cython by default: <your CMAKE_INSTALL_PREFIX>/cython
If GTSAM_USE_SYSTEM_EIGENCY is OFF, the included version of eigency will also be built and installed in that folder.
- Modify your PYTHONPATH to include the GTSAM_CYTHON_INSTALL_PATH: - Modify your PYTHONPATH to include the GTSAM_CYTHON_INSTALL_PATH:
```bash ```bash
export PYTHONPATH = $PYTHONPATH:<GTSAM_CYTHON_INSTALL_PATH> export PYTHONPATH = $PYTHONPATH:<GTSAM_CYTHON_INSTALL_PATH>
``` ```
UNIT TESTS UNIT TESTS
========== ==========
The Cython toolbox also has a small set of unit tests located in the The Cython toolbox also has a small set of unit tests located in the
@ -68,6 +66,7 @@ Examples:
WRAPPING YOUR OWN PROJECT THAT USES GTSAM WRAPPING YOUR OWN PROJECT THAT USES GTSAM
========================================= =========================================
(_TO BE UPDATED_)
- Set PYTHONPATH to include ${GTSAM_CYTHON_INSTALL_PATH} - Set PYTHONPATH to include ${GTSAM_CYTHON_INSTALL_PATH}
+ so that it can find gtsam Cython header: gtsam/gtsam.pxd + so that it can find gtsam Cython header: gtsam/gtsam.pxd
@ -88,8 +87,6 @@ wrap_and_install_library_cython("your_project_interface.h"
#Optional: install_cython_scripts and install_cython_files. See GtsamCythonWrap.cmake. #Optional: install_cython_scripts and install_cython_files. See GtsamCythonWrap.cmake.
``` ```
KNOWN ISSUES KNOWN ISSUES
============ ============
- Doesn't work with python3 installed from homebrew - Doesn't work with python3 installed from homebrew