Setup Guide

This guide provides a detailed documentation on how to install NEST Desktop.

You can read the installation instructions by clicking one of these logos below:


Via Python Package

../_images/pypi-logo.svg

  1. Both NEST Desktop and NEST Server require NEST Simulator supporting only in Linux systems.

Note

For more information read the full installing docs of NEST Simulator here.

  1. NEST Desktop is distributed on PyPI and can be installed with pip:
pip3 install nest-desktop [--user] [--upgrade]

It installs NEST Server (nest-server) automatically. For more information read the full installing docs here.

  1. Before you start the frontend NEST Desktop, you have to run NEST Server as a backend.

Start NEST Server:

nest-server start

NEST Server is now serving at http://localhost:5000.

  1. Start NEST Desktop (in other terminal session):
nest-desktop start

NEST Desktop is now serving at http://localhost:8000.

For more information read the full documentation of command API here.

Via Docker

../_images/Moby-logo.png

Docker is a virtualization software packaging applications and its dependencies in a virtual container that can run on any Linux server. It is available for a variety of operating systems, e.g. Linux, Mac and Windows. For more information here.

  1. Pull the image from docker hub:
docker pull babsey/nest-desktop
  1. Start the docker container:
docker run -i -p 5000:5000 -p 8000:8000 -t babsey/nest-desktop

Note

In Docker container NEST Desktop is serving at port 8000 and NEST Server at port 5000. So, we need to bind ports (5000 and 8000) of host and container.

NEST Desktop and NEST Server are now serving at http://localhost:8000 and http://localhost:5000, respectively.

Arguments

You can find help text of docker arguments by docker run --help.

-p Publish a container’s port(s) to the host
-i Keep STDIN open even if not attached
-t Allocate a pseudo-TTY

Via Singularity

../_images/singularity-logo.svg

Singularity is an application container for Linux systems. For more information read the full documentation here.

  1. Clone working copy from respository:
git clone https://github.com/babsey/nest-desktop
  1. Go to Singularity folder of NEST Desktop:
cd nest-desktop/singularity
  1. Build singularity container (with sudo):
singularity build nest-desktop.sif nest-desktop.def
  1. Start singularity container
singularity run nest-desktop.sif

NEST Desktop and NEST Server are now serving at http://localhost:8000 and http://localhost:5000, respectively.