diff --git a/README.md b/README.md index 6acd78b08b3a52c4b8e645499b3508f28db15eb5..db0b29c19acce76a8d6138b140438d302bb17b74 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ Tested on RobotWare version: 1. Clone this repo. 2. Install `protoc` from protobuf. There are [prebuilt binaries available from - GitHub](https://github.com/protocolbuffers/protobuf/releases/latest) if `protoc` is not available in your package manager. + GitHub](https://github.com/protocolbuffers/protobuf/releases/latest) if + `protoc` is not available in your package manager. If you use conda it can be + found in conda-forge/libprotobuf (`conda install -c conda-forge + libprotobuf`), you can use `conda env create -f environment.yml` to get all + requirements for this repo as well. 3. Find `egm.proto` in either `%LOCALAPPDATA%\ABB\RobotWare\RobotWare_6.XXXXX\utility\Template\EGM\egm.proto` or on the robot. @@ -18,7 +22,8 @@ Tested on RobotWare version: protoc --python_out=path/to/repo_folder/abb_egm_pyclient path/to/egm.proto ``` -5. Install this package in your environment of choice by running the following inside the repository directory. +5. Install this package in your environment of choice (e.g. `conda env create -f + environment.yml` or `python -m virtualenv .venv`) by running the following inside the repository directory. ```bash pip install -e . @@ -34,7 +39,7 @@ And on your computer (and your python environment): python -m abb_egm_pyclient.run --help # example given -python -m abb_egm_pyclient.run 6510 joint 30 0 0 20 10 0 0 +python -m abb_egm_pyclient.run --port 6510 joint 30 0 0 20 10 0 0 ``` Or import the client from your own code: diff --git a/environment.yml b/environment.yml index e3d6901d766ec8ebfb5e9b26055a8d1cb05ac637..87c9778906d248e0a7c860061d53450c9679606e 100644 --- a/environment.yml +++ b/environment.yml @@ -4,5 +4,6 @@ channels: dependencies: - numpy - python >=3.7, <3.13 - - protobuf + - protobuf # python protobuf bindings + - libprotobuf # includes protoc - ruff