diff --git a/CAL/CalibrationCommon/doc/CalibrationCommon.md b/CAL/CalibrationCommon/doc/CalibrationCommon.md index d7775634788bfe6436510f86c9c138884ab202f3..ade7fbe8a282287a63defe9e7a01992ee8bbafd6 100644 --- a/CAL/CalibrationCommon/doc/CalibrationCommon.md +++ b/CAL/CalibrationCommon/doc/CalibrationCommon.md @@ -50,7 +50,7 @@ meetings with stakeholders.* - *Where are the log files?* ### Runtime -- *Where does it run? (which user@machine)* +- *Where does it run? (which user machine)* - *How do I run it? (user documentation? examples? commandline parameters?)* - *Other considerations? (what happens elsewhere when I start or stop it?)* diff --git a/CAL/CalibrationCommon/doc/Holography_Data_Set.md b/CAL/CalibrationCommon/doc/Holography_Data_Set.md index 17d306294997a5eab5c22f9292f91e54de5dab29..892984981a1616630422583c8f33ca27489482c6 100644 --- a/CAL/CalibrationCommon/doc/Holography_Data_Set.md +++ b/CAL/CalibrationCommon/doc/Holography_Data_Set.md @@ -1,4 +1,4 @@ -# Definition of the LOFAR Holography Data Set +# Definition of the LOFAR Holography Data Set {#HolographyDataset} Authors: [Thomas Jürges](mailto:jurges@astron.nl), [Mattia Mancini](mailto:mancini@astron.nl) diff --git a/CAL/doc/Calibration.md b/CAL/doc/Calibration.md new file mode 100644 index 0000000000000000000000000000000000000000..bf15887e1e7e3f5245854d3882c26af0a73d71e8 --- /dev/null +++ b/CAL/doc/Calibration.md @@ -0,0 +1,93 @@ +# Calibration {#Calibration} + +## GENERAL +The calibration package contains all the source code regarding the + calibration of the LOFAR station array. + +### Description +The calibration package contains code to process the holography datasets +and derive the calibration tables for each station. +To do so, it provides a conversion util to an intermediate data container +called [HolographyDataset](@ref HolographyDataset) for each station target +of the calibration. Furthermore, the calibration package contains +the routines to process the HolographyDataset in order to derive the +gains to apply on each antenna and generate a calibration table. + +### Author/Owner + [Thomas Jürges](mailto:jurges@astron.nl), [Mattia Mancini](mailto:mancini@astron.nl) +### Overview +- *Add a diagram* +- *Add a link to the overview diagram* +- *Add a link in the overview diagram to link back to this documentation*. + +- - - + +## DEVELOPMENT + +### Analyses +*Add non-technical information and functional considerations here, like user requirements and links to minutes of +meetings with stakeholders.* + +### Design +*Add technical considerations and design choices here* + +### Source Code +- *Add a link to svn (trunk).* +- *Add a link to (generated?) source code documentation.* + +### Testing +- *How do you run unit tests?* +- *How do you run integration tests?* +- *Add a link to Jenkins jobs (if available)* + +### Build & Deploy +- *Add a link to general instructions or describe specifics here.* +- *Add a link to Jenkins jobs (if available)* + +- - - + +## OPERATIONS + +### Configuration +- *Where is the configuration file?* +- *What are the configuration options?* + +### Log Files +- *Where are the log files?* + +### Runtime +- *Where does it run? (which user @ machine)* +- *How do I run it? (user documentation? examples? commandline parameters?)* +- *Other considerations? (what happens elsewhere when I start or stop it?)* + +### Interfaces (API) +- *Describe interfaces to other applications (REST API? http requests? Messagebus?)* +- *Other communication (user? import/export?)* + +### Files/Databases +- *Which databases are used?* +- *Which files are used?* + +### Dependencies +- *To/from other applications?* +- *Files?* +- *Network locations?* +- *Other?* + +### Security +- *Special privileges needed?* +- *User login?* +- *Certificates needed?* +- *Other considerations?* + +- - - + +## ADDITIONAL INFORMATION + +### User Documentation + +*e.g. Please refer to URL X for the User Documentation* + +### Operations Documentation + +*e.g. Please refer to URL X for Operations Documentation* diff --git a/CAL/doc/Method description.pdf b/CAL/doc/Method description.pdf new file mode 100644 index 0000000000000000000000000000000000000000..d88c2c62c99a50c9afac57a8975aaa60cc6b3635 Binary files /dev/null and b/CAL/doc/Method description.pdf differ diff --git a/CAL/doc/package.dox b/CAL/doc/package.dox new file mode 100644 index 0000000000000000000000000000000000000000..e53d1d6e7dc15cd6069a81ef09456dacd33bbc4f --- /dev/null +++ b/CAL/doc/package.dox @@ -0,0 +1,9 @@ +/** + +\ingroup Packages +\defgroup Calibration Calibration + +\ref Calibration + +The CalibrationCommon package contains documentation and software that concerns all areas of LOFAR calibration. +*/