Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
doc/main.md
1 /**
2 \anchor Main
3 \mainpage Introduction
4 
5 This document describes the Cheetah project and its API (Application Programming Interface).
6 
7 \section main_whatis What is Cheetah?
8 
9 Cheetah is a set of computational pipelines for processing beamformed data from radio telescopes.
10 It has been developed as a prototype for the SKA non imaging pipeline.
11 */
12 
13 - @subpage apps Cheetah Applications
14 
15 \section main_developers Documents for Developers
16 - @subpage architecture Architecture Documents
17 - @ref dev_guide Developers Guide
18 - @ref code_review_guide Guide for Code Reviewers
19 
20 /** @defgroup core Cheetah modules */
21 /** @defgroup test_utils Cheetah Test utility modules */
22 /** @defgroup architecture Cheetah Architecture Descriptions */
23 /** @defgroup apps Applications */