Getting started

Note

This part is mostly provided by the SeaBroomPhi team and focuses on the RekenRobot.

  • It is (structurally) updated to integrate it by Albert4
  • Future teams should update it! (both context & structure)

Last update: sPYinkenHof (07-02-2018)

Section author: SeaBroomPhi

This section describes how to get the software and tooling used in this project/training up and running.

Summary

Version control

Version control allows you to work as a group on one final version on your own hard drive and not in a browser. This is done with the use of Bitbucket and Mercurial. Bitbucket is the host repository where all versions are stored, Mercurial is the tool to share this data. Before files are shared it is possible to show a local version of the documentation on your device by using Sphinx. This tool can transcript reStructuredText files (.rst) to a HTML website.

Documentation using Sphinx

Documentation is written in plain text files using the .rst format. These files can be converted to HTML using a python package called Sphinx

Raspberry Pi

The Raspberry Pi is a minicomputer which will be used to run the RekenRobot software. At the start of the course you will receive on from the teacher (Albert). Some of the Pi’s may already have software installed on it and it could be ready to run. If this is not the case, you will have to install a number of programs in order to run the RekenRobot software on the Pi. Programs needed to interact and use the Raspberry Pi are described below.

Editors

An editor is a software tool used to edit certain types files. For example, if you would want to edit a python file you would need an editor to do so. Two editors will be described in this section: a Python editors and an all-round editor.

Running the Demo

Ultimately, the RekenRobot will become a “plug in” of the Pathways-project. For now, a (standalone) demonstrator is used.

Although it should be run on the RaspberryPi; one can try it first on the PC.