https://github.com/borglab/gtsam-project-python

Project template using GTSAM + python wrapping
https://github.com/borglab/gtsam-project-python

Last synced: over 1 year ago
JSON representation

Project template using GTSAM + python wrapping

• Host: GitHub
• URL: https://github.com/borglab/gtsam-project-python
• Owner: borglab
• License: bsd-2-clause
• Created: 2019-06-13T19:00:49.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-12-28T00:51:29.000Z (over 4 years ago)
• Last Synced: 2023-05-06T16:52:05.486Z (over 3 years ago)
• Language: CMake
• Size: 1.16 MB
• Stars: 44
• Watchers: 18
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gtsam-project-python

Project template using GTSAM + Python wrapping

## PREREQUISITES

- Python 3.6+ is required, since we support these versions.

- To install the wrap package via `GTSAM`:

  - Set the CMake flag `GTSAM_BUILD_PYTHON` to `ON` to enable building the Pybind11 wrapper.

  - Set the CMake flag `GTSAM_PYTHON_VERSION` to `3.x` (e.g. `3.7`), otherwise the default interpreter will be used.

  - You can do this on the command line as follows:

    ```sh

    cmake -DGTSAM_BUILD_PYTHON=ON -DGTSAM_PYTHON_VERSION=3.7 ..

    ```

- Alternatively, you can install the wrap package directly from the [repo](https://github.com/borglab/wrap), but you will still need to install `GTSAM`.

## INSTALL

- In the top-level directory, create the `build` directory and `cd` into it.

- Run `cmake ..`.

- Run `make`, and the wrapped module will be installed to the `python` directory in the top-level.

- To install the wrapped module, simply run `make python-install`.

- You can also run `python main.py` which calls the wrapped module, to get a flavor of how it works.

## DOCUMENTATION

For more detailed information, please refer to the [tutorial](TUTORIAL.md).