.. _structure:

General structure
=================

Welcome to the LOFAR Software Documentation, the documentation generated from the 
`LOFAR Git tree <https://git.astron.nl/ro/lofar.git>`_ (`Browser View <https://git.astron.nl/ro/lofar>`_) using 
`Doxygen <http://www.doxygen.nl/>`_. 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 <https://www.astron.nl/lofarwiki>`_.

Quick Links
------------

.. - `LOFAR Release Notes`_
- :ref:`LOFAR Release Notes <changelog>`

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 <https://docs.google.com/spreadsheets/d/1JC8zHE7Vx3RyuQWJFAhUd_hUtxQjatORp8V8bYZ3soA/edit?ts=599bc23c#gid=326610509>`_ 
for example `this DrawIO drawing <https://www.draw.io/?state={%22ids%22:[%220B5fohp6auM-uWlVYajlZcTc2SDg%22],%22action%22:%22open%22,%22userId%22:%22102373349346206970364%22}#G0B5fohp6auM-uWlVYajlZcTc2SDg>`_.

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 <https://www.astron.nl/lofarwiki/doku.php?id=engineering:software_support_start>`_ 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 <https://support.astron.nl/lofar_issuetracker>`_.
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 <pages.html>`_ page.

Development
-----------

Standards & Procedures
^^^^^^^^^^^^^^^^^^^^^^

- For software documentation, refer to the :ref:`Software Documentation Template <sw_documentation_template>`.
- `Definition of Done <https://www.astron.nl/lofarwiki/doku.php?id=engineering:software:scrum&s[]=dod>`_
- Review Checklist
- `Coding Conventions <https://www.astron.nl/lofarwiki/doku.php?id=engineering:software:codingconventions>`_
- Testing Conventions
- `Software Development Policy <https://www.astron.nl/lofarwiki/doku.php?id=engineering:software:developmentmanagementpolicy>`_
- `LOFAR Release Procedure <https://www.astron.nl/lofarwiki/doku.php?id=engineering:software:releaseprocedure>`_
- :ref:`Glossary <glossary>`

Usage
-----

Copyright & Licenses
^^^^^^^^^^^^^^^^^^^^

The copyright of this documentation and all LOFAR source code is owned by 
`ASTRON <http://www.astron.nl/>`_ unless granted otherwise by the applicable license(s). Refer to the 
`COPYING <https://git.astron.nl/ro/lofar/-/raw/master/COPYING>`_ file for more information.