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.

Work on the source code

First, prepare the development environment with the required packages.

yarn serve

The Live Development Server is serving at http://localhost:8080.

Setup

It is possible to install NEST Desktop from source code on a local machine using pip (where it finds setup.py). The recommended method is to install it in the user’s home directory using the command argument --user.

python3 -m pip install --user -e .
nest-desktop start

Note

Do not forget to start NEST Simulator.

Commit changes

Go to the dev branch for the development.

git checkout dev

Fetch the data from GitHub (download it to your local directory):

git fetch

If required, intergrate the changes from GitHub into your local repository:

git pull

It is recommended to create a new branch for an an implementation of a new feature/goal.

git checkout -b newBranch

If your changes are ready to be commited, stage and commit them:

git add ...
git commit -m 'This is my commit.'

Finally, push all of them to repository on the internet (and create a merge request afterwards).

git push --set-upstream origin newBranch