Skip to content

Commit c5023d3

Browse files
authored
Add Python instructions to readme (#821)
1 parent f787321 commit c5023d3

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![codecov](https://codecov.io/gh/tesseract-robotics/tesseract/branch/master/graph/badge.svg?token=nh4aHZzgpR)](https://codecov.io/gh/tesseract-robotics/tesseract)
44

5-
[![Python](https://img.shields.io/badge/python-2.7+|3.6+-blue.svg)](https://github.com/tesseract-robotics/tesseract_python)
5+
[![Python](https://img.shields.io/badge/python-3.7+-blue.svg)](https://github.com/tesseract-robotics/tesseract_python)
6+
7+
![PyPI](https://img.shields.io/pypi/v/tesseract-robotics)
68

79
Platform | CI Status
810
---------------------|:---------
@@ -31,6 +33,25 @@ The planning framework (Tesseract) was designed to be light weight, limiting the
3133

3234
[![](https://github.com/snapcore/snap-store-badges/blob/master/EN/%5BEN%5D-snap-store-black-uneditable%401x.png)](https://snapcraft.io/tesseract-ignition)
3335

36+
## Python Installation
37+
38+
A self contained Tesseract Python package is available on PyPI for Windows 10+, Ubuntu 20.04, and Ubuntu 22.04. This package
39+
contains Tesseract, Tesseract Planning, and all dependencies in the single package. Packages are available for Python
40+
3.7 - 3.10.
41+
42+
To install on Windows:
43+
```
44+
python -m pip install tesseract-robotics tesseract-robotics-viewer
45+
```
46+
To install on Ubuntu 20.04 and Ubuntu 22.04:
47+
48+
```
49+
sudo apt install python3-pip python3-numpy
50+
# The supplied version of pip on Ubuntu 20.04 is too old for manylinux_2_31, upgrade pip
51+
python3 -m pip install -U pip
52+
python3 -m pip install --user tesseract_robotics tesseract_robotics_viewer
53+
```
54+
3455
## Tesseract Core Packages
3556

3657
* **tesseract** – This is the main class that manages the major component Environment, Forward Kinematics, Inverse Kinematics and loading from various data.

0 commit comments

Comments
 (0)