Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The SIC framework can be installed on your machine by making use of Docker.

Table of Contents

Requirements

  • Java 8+ (e.g. download JDK 19 and follow installation instructions)

  • Python 3.8+

  • Please make sure that you have at least 8 GBs of RAM on your machine. We also highly recommend a somewhat decent processor.

  • It is worth checking if your WiFi adapter's drivers are up-to-date (see e.g. here on how to do that).

Installation

  1. Download and install Git and the Git-LFS extension.

    1. On Windows, make sure Git is configured to 'checkout as-is', e.g. by configuring this in the installation (re-install Git if you are unsure about this)

    2. ❗ Make sure that Git-LFS is enabled (by running git lfs install)

  2. Make sure ports 6379, and 8000-8003 can be reached on your machine (i.e. by a robot).

    • On Windows and Mac, this is generally not a problem (though some firewalls like McAfee might interfere, and make sure to allow Docker to work on all networks when requested); on Linux systems your firewall will likely have to be adjusted.

  3. Our infrastructure runs in Docker containers, so please check if you meet the relevant system requirements in order to download and install Docker Desktop (Windows/Mac) or Docker Engine (Linux).

    • Using Docker Desktop may cause conflicts with virtualisation tools like VirtualBox and VMWare.

    • If you cannot use Docker Desktop, download and install Docker Toolbox instead.

    • Please read and follow the installation instructions of either tool carefully!

  4. Clone the SIC Git repository in a folder under your user directory:

    • git clone https://bitbucket.org/socialroboticshub/docker.git

...