Easily install on your computer

Targeted audience

This installation is meant for end users who want to try out the Platform locally on their computer by cloning template experiments, or creating new ones with our template models.
It is not intended for advanced users or developers who need to change code in the Platform or add Gazebo plugins and robot controllers. These users should install the Platform from source.
This installation uses Docker as the underlying package manager. It is technically possible for users to open a shell in the containers and hack them, but they must be aware that containers are replaced on Platform updates and all there changes inside containers will be lost.
Of course, all user data, custom experiments and models are safe and kept between updates!

Windows pre-step

Linux/Mac users, skip this part
1. Windows users have to first install WLS (Windows Linux Subsystem) and a brand of Linux on top of it from the Windows Store (we tested with Ubuntu 16.04). See here for instructions.
2. Open an Linux terminal from the Windows start menu (in our case an Ubuntu menu item) and proceed with the next step.

MacOS pre-step

Linux/Windows users, skip this part
(Note on MacOS only docker versions >= 18.03 are supported)
1. Add an alias into your hosts file:
echo " host.docker.internal" | sudo tee -a /etc/hosts
2. Restart your computer.

Install with Docker

This install procedure should work on any Linux OS, MacOS (with docker version >=18.03) and on Windows 10 if you did the preparatory part. Other operating systems have not been tested and it is likely they will not work with this bash script.

1. The first preliminary step is to install Docker on your system.
2. Then download the following script and run it in a terminal (Linux terminal for Windows users). The script should auto-update itself later when needed.

Docker installer

3. The following steps will install and configure the docker images of the NRP on your system. Your user data will be stored in Docker volumes. So everything is cleanly self contained.
chmod 755 nrp_install.sh
./nrp_install.sh install
You can run the script without any arguments to get a list of other options, e.g. uninstall, restart, connect to containers (open a bash inside them) etc.

Windows post-step

Linux/Mac users, skip this part
You need to add a route to connect to the docker containers. Open PowerShell as Administrator and run:
route add [subnet].0.0 MASK
where subnet is defined in the installer script (bottom).

Connect to the Neurorobotics Platform

After running the script, to connect to the platform open your browser (Firefox and Chrome are officially supported) and go to the following link: http://localhost:9000/#/esv-private.
You will be prompted to enter a username and password. On local installs like this one, there is a default user "nrpuser" and password "password". Creating new users is currently not possible from the user interface.

Warning with low-bandwidth networks

This install procedures involves downloading a couple of GBs from the internet. Public wifi or slow connections will take a long time or possibly fail.


If there are troubles setting up the docker network, you can try a different subnet by changing it in the installer script.