General structure

Welcome to the LOFAR Software Documentation, the documentation generated from the LOFAR Git tree (Browser View) using Doxygen. Its target audience includes Developers, Software Support Personnel, and System Administrators. For End-User Documentation and information for Operators, please refer to the LOFAR-wiki.

Doxygen

Refer to the `Doxygen Quick Guide`_ for information on how to write documentation for Doxygen. When documenting software components, please use and adhere to the `Software Documentation Template`_.

Architecture

Top-level

Link to some online top-level diagram of LOFAR generated by the drawing tool chosen from the Drawing Tool Comparison for example this DrawIO drawing.

Sub-systems

The LOFAR Software System can be decomposed into several sub-systems:

  • CEP
    • Pipelines

      • Pulsar

      • Default Pre Processing Pipeline

      • Inspection Plots Pipeline

      • Adder

  • SAS

    • XML Generator

    • OTB

      • Scheduler

    • Resource Assignment

      • Responsive Telescope

      • Dragnet

      • WebScheduler

  • MAC
    • Central (CCU)

      • Observation Control

      • MAC Scheduler

    • Station (LCU)

      • Station Control

      • Hardware Monitor

      • Clock Control

      • BeamServer

      • CalibrationServer

      • TBB

      • RSP

      • Station Test

    • WinCC

  • MOM (not in this repository)

  • LTA

    • Ingest

    • Staging (not in this repository)

  • Cobalt

  • NorthStar (not in this repository)

  • RTSM

Support & Maintenance

Please refer to the Software Support Start Page for the Support schedule, a F.A.Q., and further information on support and maintenance.

Reporting Bugs

LOFAR developers can file their bug reports in the LOFAR Issue Tracker. Alternatively, one can submit a bug report by sending an email to mailto:softwaresupport@astron.nl.

Todos and bugs identified in the source code are listed on their individual pages, which are available on the Related Pages page.

Development

Standards & Procedures

Usage