Contents 1 Code Documentation 1.1 Folder/file structure 1.1.1 root 1.1.2 test 1.1.3 debian 1.2 Coding Standards

Code Documentation

This page should provide some information and overview on the SciCraft code base. Hopefully it will be useful to external programming-savvy users as well as internal developers. Feel free to request specific information through the scicraft (AT) scicraft (DOT) org mailaddress or the MailingLists.

Folder/file structure

Currently the main directory structure of the source code is as follows:

    + debian
    + test + system
           + workflows

root

The main directory contains the executable scicraft python script, README, etc. The files there, together with the files in icons, system and workflows comprise the main program source code.

test

The test directory mirrors the directory structure of the main source code. Here the unit tests have been placed. These are runnable through make test in the main directory.

debian

Within the debian directory you can find the necessary files to produce debian/ubuntu-packages.

Coding Standards

We strive to abide by the Style Guide for Python Code (PEP 8).