Warning

This version of the documentation is NOT an official release. You are looking at version ‘latest’, which is in active and ongoing development. You can change versions at the bottom left of the screen.

Prepare the environment

NEST Desktop is written in Vue.js (a web framework written in TypeScript), and also in TypeScript. The Vue code is transpiled to HTML5 and JavaScript Code. There are multiple ways to develop Vue applications, but my preferred way (and probably the most common one) to develop NEST Desktop is to use Node.js (and optionally Yarn). Therefore, if you do not use any of the container systems mentioned below, you will need to install Node.js (for Windows, an easy installation guide can be found here ), which gives you also the possibility to install Yarn.

Requirements
  • Python 3.6 or higher
  • Node.js, Yarn
  • NEST Simulator 3.0 or higher

You can install these requirements in the host system.

However, I prefer to use a Singularity container and leave the host system unchanged. For this, I prepared a Singularity recipe that build a container with the required packages for the development. You can find the definition file in singularity/nest-desktop-dev.def for building this Singularity container.


Build an environment with Singularity

The definition file singularity/nest-desktop-dev.def contains an adequate environment to develop and build NEST Desktop.

Build a singularity image:

singularity build nest-desktop-dev.sif singularity/nest-desktop-dev.def

Go to the shell of singularity container:

singularity shell nest-desktop-dev.sif

Node modules

Install node modules for NEST Desktop:

yarn install

Check if any node modules are outdated:

yarn outdated

Upgrade outdated node modules:

yarn upgrade