https://github.com/borglab/gtsam-manylinux-build
https://github.com/borglab/gtsam-manylinux-build
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/borglab/gtsam-manylinux-build
- Owner: borglab
- Created: 2020-01-04T22:08:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-15T18:25:08.000Z (over 2 years ago)
- Last Synced: 2025-05-07T13:53:09.582Z (over 1 year ago)
- Language: Shell
- Size: 115 KB
- Stars: 1
- Watchers: 17
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Audit: auditwheel.txt
Awesome Lists containing this project
README
# GTSAM Python Wheel Builder


## How to Build on Linux
Run:
```bash
sudo docker run --rm -e PLAT=manylinux2014_x86_64 PLAT=manylinux2014_x86_64 -e PYTHON_VERSION=$PYTHON_VERSION -v `pwd`:/io varunagrawal/gtsam-manylinux:latest /io/build-wheels.sh
```
You will need to rename the built files to a valid name. E.g.:
```bash
mv gtsam-4.1.0-cp36-cp36m-manylinux2014_x86_64.none-manylinux2014_x86_64.whl gtsam-4.1.0-cp36-none-any.whl
```
## How to Build on macOS
Please consult `build-macos-wheels.sh`.
# Current Build Date
2023-09-02
We are building for the 4.2 release.
## Wheel Update Instructions
For all OSs and architectures we support:
First check if the wheels you have built can actually install and run by:
1. Create a clean virtual environment
2. `pip install {WHEEL}.whl` to install the wheel
3. run the GTSAM unit tests to make sure the wheel works by going to `gtsam_repo/python/gtsam/tests` and `python -m unittest discover`
* The most probable failures at this stage are:
* The wheel repair (auditwheel/delocate) programs have bugs and produced wrong binaries.
* Which needs manual patching, contact @ProfFan immediately
If you have confirmed that it works, you can then:
* Run `pip install twine` to install Twine
* After that, upload to Test PyPI by:
```bash
twine upload --repository testpypi {WHEEL_FILE_NAME}.whl
```
* Now, uninstall `gtsam` in the virtual env, do
```bash
pip install --index-url https://test.pypi.org/simple {PACKAGE_NAME}
```
and test again with the unit tests
* The most probable failures at this stage are:
* Inconsistent version tags between the METADATA and the file name of the wheel
* You did not test the wheel you uploaded in a fresh machine, so it's linking is not correct (only works for you)
* If that still works, you can try upload to REAL PyPI (THIS IS IRREVERSIBLE!!!)
```bash
twine upload {WHEEL_FILE_NAME}.whl
# OR if you tested all 8 wheels on Test PyPI and possible users
twine upload {directory containing all wheels}
```
* Finally test again by using normal `pip install gtsam`
* Rinse and repeat with every architecture that you are concerned with.