Skip to content

Home

Jump to bottom
Kilian Holzapfel edited this page Dec 20, 2021 · 13 revisions

Documentation

This is the documentation of the STRAWb-package but also the related infrastructure like ONC and LRZ.

ONC hosts a database (DB) with all data from the measurements of the deployed modules.

LRZ provides a storage system called DSS and a VM (virtual machine) hosting services (Compute Cloud). The DSS holds a daily synced copy of all files of the ONC DB related to STRAWb.

Please also have a look to the repository's readme with information about installing the package and more.

Table of Contents

  1. List of Files of the Documentation
  2. Code Structure
  3. Example
  4. Git and IDE

List of Files of the Documentation

  1. Code Structure
    1. Package Config File
    2. Sensor
      1. Camera
      2. (more to be added)
    3. ONC - How to access the data
  2. SSH to Modules - How to access the modules
  3. LRZ - access the DSS and computational resources (VMs)
    1. How to mount the DSS container
  4. Git and IDE

Code Structure

The code consists of several submodules. The following summarise the single parts briefly, for more documentation also have a look to other files here in this Wiki.

Config Parser

Takes care of parsing configuration parameters for the package from a config file. The sample config file with all parameters is here. If there is a config-file present at ~/.strawb/config it reads the parameters from there. If not, it takes the sample config-file.

ONCDownloader

Takes care of downloading the files from the ONC server to a local directory. Readme of the submodule.

Sensors

STRAWb consists of several Modules with different configurations of sensors. The code of the DAQ and module controlling software (MCTL) is located in this repository (TUM resource, but external users can be added. Contact someone of the TUM group for access).

Most of the sensors use hdf5 files to store the measurements. But some sensors use other file types like txt, hld, raw and png.

To keep this Readme short, each sensor has a separated readme in this Wiki.

Example

For examples check out the examples' folder which includes notebooks and scripts.

Git and IDE

Git is the platform and software to develop, share, and sync software. An IDE (integrated development environment) is a tool to simplify coding. More information are on Wikipedia.

Bootcamp

To simplify the start with the project and the software we did a bootcamp in December 2021. All Bootcamps are listed here.

Clone this wiki locally