From 457e52d05db4841cf713fcd0b736a7824591b279 Mon Sep 17 00:00:00 2001 From: John Lambert Date: Mon, 21 Sep 2020 09:04:17 -0400 Subject: [PATCH 1/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc8af7248..60eff197a 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ GTSAM 4.1 added a new pybind wrapper, and **removed** the deprecated functionali ## Wrappers -We provide support for [MATLAB](matlab/README.md) and [Python](cython/README.md) wrappers for GTSAM. Please refer to the linked documents for more details. +We provide support for [MATLAB](matlab/README.md) and [Python](python/README.md) wrappers for GTSAM. Please refer to the linked documents for more details. ## The Preintegrated IMU Factor From bcaed27c54006010e76488f838ac13c541c82dcf Mon Sep 17 00:00:00 2001 From: John Lambert Date: Mon, 21 Sep 2020 09:38:35 -0400 Subject: [PATCH 2/5] improve python wrapper cmake flag instructions --- python/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/python/README.md b/python/README.md index b1a3a865f..bb883222c 100644 --- a/python/README.md +++ b/python/README.md @@ -7,7 +7,10 @@ This is the Python wrapper around the GTSAM C++ library. We use our custom [wrap ## Requirements - 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 when running `cmake` otherwise the default interpreter will be used. + use the `-DGTSAM_PYTHON_VERSION=3.6` option when running `cmake` otherwise the default interpreter will be used. For example: + ```bash + cmake .. -DGTSAM_BUILD_PYTHON=1 -DGTSAM_PYTHON_VERSION=3.6.10 + ``` - If the interpreter is inside an environment (such as an anaconda environment or virtualenv environment), then the environment should be active while building GTSAM. - This wrapper needs `pyparsing(>=2.4.2)`, and `numpy(>=1.11.0)`. These can be installed as follows: From bb22773a810c2d1f341ca2b2f41b7219f3a29114 Mon Sep 17 00:00:00 2001 From: John Lambert Date: Mon, 21 Sep 2020 09:39:46 -0400 Subject: [PATCH 3/5] Update README.md --- python/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/README.md b/python/README.md index bb883222c..be69034f9 100644 --- a/python/README.md +++ b/python/README.md @@ -7,7 +7,7 @@ This is the Python wrapper around the GTSAM C++ library. We use our custom [wrap ## Requirements - 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 when running `cmake` otherwise the default interpreter will be used. For example: + use the `-DGTSAM_PYTHON_VERSION=3.6` option when running `cmake` otherwise the default interpreter will be used. For example, if you local Python version is 3.6.10, then run: ```bash cmake .. -DGTSAM_BUILD_PYTHON=1 -DGTSAM_PYTHON_VERSION=3.6.10 ``` From 133b81867c1bf4fcd9d619ffa7bddba024e8a28e Mon Sep 17 00:00:00 2001 From: John Lambert Date: Mon, 21 Sep 2020 09:40:42 -0400 Subject: [PATCH 4/5] Update README.md --- python/README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/python/README.md b/python/README.md index be69034f9..be5d316b1 100644 --- a/python/README.md +++ b/python/README.md @@ -7,10 +7,7 @@ This is the Python wrapper around the GTSAM C++ library. We use our custom [wrap ## Requirements - 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 when running `cmake` otherwise the default interpreter will be used. For example, if you local Python version is 3.6.10, then run: - ```bash - cmake .. -DGTSAM_BUILD_PYTHON=1 -DGTSAM_PYTHON_VERSION=3.6.10 - ``` + use the `-DGTSAM_PYTHON_VERSION=3.6` option when running `cmake` otherwise the default interpreter will be used. - If the interpreter is inside an environment (such as an anaconda environment or virtualenv environment), then the environment should be active while building GTSAM. - This wrapper needs `pyparsing(>=2.4.2)`, and `numpy(>=1.11.0)`. These can be installed as follows: @@ -21,8 +18,10 @@ This is the Python wrapper around the GTSAM C++ library. We use our custom [wrap ## Install -- Run cmake with the `GTSAM_BUILD_PYTHON` cmake flag enabled to configure building the wrapper. The wrapped module will be built and copied to the directory `/python`. - +- Run cmake with the `GTSAM_BUILD_PYTHON` cmake flag enabled to configure building the wrapper. The wrapped module will be built and copied to the directory `/python`. For example, if you local Python version is 3.6.10, then run: + ```bash + cmake .. -DGTSAM_BUILD_PYTHON=1 -DGTSAM_PYTHON_VERSION=3.6.10 + ``` - Build GTSAM and the wrapper with `make` (or `ninja` if you use `-GNinja`). - To install, simply run `make python-install` (`ninja python-install`). From fe0312fd63b404dd3f304338ee2e70cf1183a28d Mon Sep 17 00:00:00 2001 From: John Lambert Date: Mon, 21 Sep 2020 09:58:03 -0400 Subject: [PATCH 5/5] Update README.md --- python/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/python/README.md b/python/README.md index be5d316b1..6e2a30d2e 100644 --- a/python/README.md +++ b/python/README.md @@ -7,7 +7,7 @@ This is the Python wrapper around the GTSAM C++ library. We use our custom [wrap ## Requirements - 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 when running `cmake` otherwise the default interpreter will be used. + use the `-DGTSAM_PYTHON_VERSION=3.6` option when running `cmake` otherwise the default interpreter will be used. - If the interpreter is inside an environment (such as an anaconda environment or virtualenv environment), then the environment should be active while building GTSAM. - This wrapper needs `pyparsing(>=2.4.2)`, and `numpy(>=1.11.0)`. These can be installed as follows: @@ -18,7 +18,7 @@ This is the Python wrapper around the GTSAM C++ library. We use our custom [wrap ## Install -- Run cmake with the `GTSAM_BUILD_PYTHON` cmake flag enabled to configure building the wrapper. The wrapped module will be built and copied to the directory `/python`. For example, if you local Python version is 3.6.10, then run: +- Run cmake with the `GTSAM_BUILD_PYTHON` cmake flag enabled to configure building the wrapper. The wrapped module will be built and copied to the directory `/python`. For example, if your local Python version is 3.6.10, then you should run: ```bash cmake .. -DGTSAM_BUILD_PYTHON=1 -DGTSAM_PYTHON_VERSION=3.6.10 ```