mainpage.md 3.5 KB
Newer Older
1 2 3 4 5 6 7
# Software Documentation

## General

### Introduction

Welcome to the LOFAR Software Documentation, the documentation generated from the 
8 9
[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 are *Developers*, *Software Support Personnel* 
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
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 release_notes)


### Doxygen

Refer to the [Doxygen Quick Guide](@ref doxygen_quick_guide) for information on how to write documentation for Doxygen. 
When documenting software components please use and adhere to this 
[Software Documentation Template](@ref sw_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

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

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
* 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
 * Injest
 * Staging (not in this repository)
* Cobalt
* NorthStar (not in this repository)
* RTSM
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

## 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 and email to <mailto:softwaresupport@astron.nl>.

Todo's and bugs identified in the source code are listed on their individual pages which are available on the 
<a href="pages.html">Related Pages</a> page.


## Development

### Standards & Procedures

- [Software Documentation Template](@ref sw_documentation_template) (*proposal*)
- [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)
100
- [Glossary](@ref glossary)
101 102 103

## Usage

104

105 106 107
### Copyright & Licenses

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