Skip to content

Commit

Permalink
Install Python SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
glannuzel committed Apr 11, 2024
1 parent b816c09 commit 5b4f5a0
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions content/sdk/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,32 @@ weight: "20"

## How to install the Python SDK

The Python SDK is a pure Python library. The installation should thus be rather straightforward. It supports Python >= 3.10 (older versions will not work because of typing syntax). It works on Windows/Mac/Linux.
The Python SDK is a pure Python library. The installation should thus be rather straightforward.

It supports Python >= 3.10 (older versions will not work because of typing syntax). It works on Windows/Mac/Linux.

We recommend to use [virtual environment](https://docs.python.org/3/tutorial/venv.html) for your development. They make the installation simple and avoid compatibility issues. They also come with their [pip](https://pip.pypa.io/en/stable/) command.

### From PyPi

```bash
pip3 install reachy-sdk
pip install reachy2-sdk
```

### From the source

```bash
git clone https://github.com/pollen-robotics/reachy-sdk
pip3 install -e reachy-sdk
git clone https://github.com/pollen-robotics/reachy2-sdk
cd reachy2-sdk
pip install -e reachy2-sdk
```

## Dependencies

The SDK relies on a few third-party Python packages:
The SDK relies on a few third-party Python packages, such as:

* [numpy](https://numpy.org) - mostly for trajectory computation
* [opencv](https://opencv.org) - for camera frame access
* [grpc](https://grpc.io) - to connect to the robot

They will be installed automatically when you install the SDK.
They will be **installed automatically** when you install the SDK.

0 comments on commit 5b4f5a0

Please sign in to comment.