Difference between revisions of "Help:Product Description Template"
m (1 revision) |
|||
| Line 1: | Line 1: | ||
This page contain a template for product description. If you have any suggestions or comments please let us know. The [[Help:Product Description Template#Header keywords|last section]] only applies to products provided as FITS files. | This page contain a template for product description. If you have any suggestions or comments please let us know. The [[Help:Product Description Template#Header keywords|last section]] only applies to products provided as FITS files. | ||
| − | ==Description of the product== | + | ===Description of the product=== |
Here you should provide a brief description of the product. You should mention what type of data is associated with the product (images,maps,timelines,...) but should refrain from describing any format details as this will be dealt with in the [[Help:Product Description Template#Data format|format]] section. | Here you should provide a brief description of the product. You should mention what type of data is associated with the product (images,maps,timelines,...) but should refrain from describing any format details as this will be dealt with in the [[Help:Product Description Template#Data format|format]] section. | ||
| − | ==Pipeline== | + | ===Pipeline=== |
This is were the pipeline generating the product should be described. In particular any limitations and approximations used in the data processing should be listed. Try to avoid detailed descriptions of methods and refer to the relevant Planck papers for the details. | This is were the pipeline generating the product should be described. In particular any limitations and approximations used in the data processing should be listed. Try to avoid detailed descriptions of methods and refer to the relevant Planck papers for the details. | ||
| − | ==Input Data== | + | ===Input Data=== |
A brief description of all the input data as well as any external ancillary data sets should be included. | A brief description of all the input data as well as any external ancillary data sets should be included. | ||
| − | ==Related products== | + | ===Related products=== |
A brief note about products that are related and share some commonalities with the product being described here. | A brief note about products that are related and share some commonalities with the product being described here. | ||
| − | ==Data format== | + | ===Data format=== |
The format of the product being described. This will include some or all of the following information: | The format of the product being described. This will include some or all of the following information: | ||
*Coordinate System | *Coordinate System | ||
| Line 21: | Line 21: | ||
*N. Of Files | *N. Of Files | ||
| − | ==Header keywords== | + | ===Header keywords=== |
For data provided in the form of fits files a table containing a description of all the header keywords should be included here. The table should follow this format | For data provided in the form of fits files a table containing a description of all the header keywords should be included here. The table should follow this format | ||
Latest revision as of 12:28, 18 July 2012
This page contain a template for product description. If you have any suggestions or comments please let us know. The last section only applies to products provided as FITS files.
Contents
Description of the product[edit]
Here you should provide a brief description of the product. You should mention what type of data is associated with the product (images,maps,timelines,...) but should refrain from describing any format details as this will be dealt with in the format section.
Pipeline[edit]
This is were the pipeline generating the product should be described. In particular any limitations and approximations used in the data processing should be listed. Try to avoid detailed descriptions of methods and refer to the relevant Planck papers for the details.
Input Data[edit]
A brief description of all the input data as well as any external ancillary data sets should be included.
Related products[edit]
A brief note about products that are related and share some commonalities with the product being described here.
Data format[edit]
The format of the product being described. This will include some or all of the following information:
- Coordinate System
- Projection
- Units
- Format
- N. Of Files
Header keywords[edit]
For data provided in the form of fits files a table containing a description of all the header keywords should be included here. The table should follow this format
| Keyword Name | Description | Unit |
|---|---|---|
| Keyword1 | this is a keyword | |
| Keyword2 | this is a another keyword |
Flexible Image Transfer Specification
