From 36637a936ba121fc627f0398110bcb15ac6869d2 Mon Sep 17 00:00:00 2001 From: mxie32 Date: Thu, 13 Jun 2019 18:53:00 -0400 Subject: [PATCH 1/3] add install instruction --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 7f1a776..1bfc4c1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # gtsam-project-python Project template using GTSAM + python wrapping + + +INSTALL +======= +- Python3 is required +- Make the following changes before build and install: + - enable `GTSAM_INSTALL_CYTHON_TOOLBOX` + - if you want to build the gtsam python library for a specific python version (eg 3.6), use the `-DGTSAM_PYTHON_VERSION=3.6` option, otherwise the default interpreter will be used. +- Run `cmake ..` +- Run `make install` (may need use sudo), and the wrapped module will be installed to `GTSAM_CYTHON_INSTALL_PATH`, which is +by default: `/cython` +- After build and install gtsam, navigate to `GTSAM_CYTHON_INSTALL_PATH` and run `python setup.py install` + +For more detailed information, please see +https://github.com/borglab/gtsam/tree/develop/cython \ No newline at end of file From a996ba0de4a5e155d2f69e702c3267886824deca Mon Sep 17 00:00:00 2001 From: mxie32 Date: Fri, 14 Jun 2019 11:24:37 -0400 Subject: [PATCH 2/3] change README according to pr comments --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1bfc4c1..a9ae97b 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,12 @@ INSTALL ======= - Python3 is required - Make the following changes before build and install: - - enable `GTSAM_INSTALL_CYTHON_TOOLBOX` - - if you want to build the gtsam python library for a specific python version (eg 3.6), use the `-DGTSAM_PYTHON_VERSION=3.6` option, otherwise the default interpreter will be used. + - Set the CMake flag `GTSAM_INSTALL_CYTHON_TOOLBOX=ON` to enable building the cython wrapper. + - Set the CMake flag `-DGTSAM_PYTHON_VERSION=3`, otherwise the default interpreter will be used. - Run `cmake ..` - Run `make install` (may need use sudo), and the wrapped module will be installed to `GTSAM_CYTHON_INSTALL_PATH`, which is by default: `/cython` -- After build and install gtsam, navigate to `GTSAM_CYTHON_INSTALL_PATH` and run `python setup.py install` +- After building and installing gtsam, navigate to `GTSAM_CYTHON_INSTALL_PATH` and run `python setup.py install` For more detailed information, please see https://github.com/borglab/gtsam/tree/develop/cython \ No newline at end of file From a775e7b3da4f566d990df82157785636e87f5e2b Mon Sep 17 00:00:00 2001 From: Varun Agrawal Date: Tue, 7 Jul 2020 12:29:08 -0400 Subject: [PATCH 3/3] updated README to be consistent with the project --- README.md | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a9ae97b..fb23a59 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ # gtsam-project-python + Project template using GTSAM + python wrapping +## PREREQUISITES + +- Python 3.6+ is required, since we support these versions. +- Make the following changes to `GTSAM`: + + - Set the CMake flag `GTSAM_INSTALL_CYTHON_TOOLBOX` to `ON` to enable building the cython wrapper. + - Set the CMake flag `GTSAM_PYTHON_VERSION` to `3`, otherwise the default interpreter will be used. + - You can do this on the command line as follows: + + ```sh + cmake -GTSAM_INSTALL_CYTHON_TOOLBOX=ON -DGTSAM_PYTHON_VERSION=3 .. + ``` + +## INSTALL -INSTALL -======= -- Python3 is required -- Make the following changes before build and install: - - Set the CMake flag `GTSAM_INSTALL_CYTHON_TOOLBOX=ON` to enable building the cython wrapper. - - Set the CMake flag `-DGTSAM_PYTHON_VERSION=3`, otherwise the default interpreter will be used. -- Run `cmake ..` -- Run `make install` (may need use sudo), and the wrapped module will be installed to `GTSAM_CYTHON_INSTALL_PATH`, which is -by default: `/cython` -- After building and installing gtsam, navigate to `GTSAM_CYTHON_INSTALL_PATH` and run `python setup.py install` +- In the `example` directory, create the `build` directory and `cd` into it. +- Run `cmake ..`. +- Run `make`, and the wrapped module will be installed to a `cython` directory. +- Navigate to the `cython` directory and run `python setup.py install`. -For more detailed information, please see -https://github.com/borglab/gtsam/tree/develop/cython \ No newline at end of file +For more detailed information, please see +[this link](https://github.com/borglab/gtsam/tree/develop/cython)