Getting started with the CaosDB Crawler

Installation

see INSTALL.md

Run Unit Tests

  1. Install additional dependencies:

  • h5py

  1. Run pytest unittests.

Documentation

We use sphinx to create the documentation. Docstrings in the code should comply with the Googly style (see link below).

Build documentation in src/doc with make html.

Requirements

  • sphinx

  • sphinx-autoapi

  • recommonmark

  • sphinx-rtd-theme

How to contribute