From 133b81867c1bf4fcd9d619ffa7bddba024e8a28e Mon Sep 17 00:00:00 2001 From: John Lambert Date: Mon, 21 Sep 2020 09:40:42 -0400 Subject: [PATCH] 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`).