Skip to content

README.md

Latest commit

 

History

History
83 lines (54 loc) · 2.65 KB

README.md

File metadata and controls

83 lines (54 loc) · 2.65 KB
Raw

pycollisionavoidance

Python Package to avoid fatal collision between human and robot in virtual environment

Stateless App Build CI/CD Workflow Status

Development

Python3.x

  1. Create a Virtual Environment

    $ virtualenv -m venv venv

  2. Activate Virtual Environment

    $ . venv/bin/activate

  3. Install the Dependencies

    $ pip install -r requirements.txt

  4. Install pycollisionavoidance as python package for development:

    $ pip install -e .

    This makes the collision-avoidance binary available as a CLI

Usage

Run collision-avoidance binary in command line:

  • -c : Configuration file path
  • -i : ID of the personnel
$ collision-avoidance -c config.yaml -i <personnel-id>

Message Broker (RabbitMQ)

Use the rabbitmqtt stack for the Message Broker

NOTE: The rabbitmqtt stack needs an external docker network called iotstack make sure to create one using docker network create iotstack

Docker

  1. To build Docker Images locally use:

    $ docker build -t pycollisionavoidance:<version> .

  2. To run the Application along with the RabbitMQ Broker connect the container with the iotstack network using:

    $ docker run --rm --network=iotstack -t pycollisionavoidance:<version> -c config.yaml -i <personnel-id>

    INFO: Change the broker address in the config.yaml file to rabbitmq (name of the RabbitMQ Container in rabbitmqtt stack)

  3. To run the a custom configuration for the Container use:

    $ docker run --rm -v $(pwd)/config.yaml:/pycollisionavoidance/config.yaml --network=iotstack -t pycollisionavoidance:<version> -c config.yaml -i <personnel-id>

Maintainers

The repository is maintained by:

BIBA - Bremer Institut für Produktion und Logistik GmbH

FUNDING

  • The development of this codebase and repository is driven through the RAINBOW Project. RAINBOW Project has received funding from the European Union’s Horizon 2020 programme under grant agreement number 871403
  • The development of this codebase and repository is driven through the ASSURED Project. ASSURED project is funded by the European Union's Horizon 2020 programme under Grant Agreement number 952697