Guidelines for the readme file

A readme file describing the names, (sub) types and associations of files needs to be provided.

  • File names
    To ensure uniqueness of all Advanced Data Products in the ESO Archive, files may need to be renamed. The following scheme was adopted for the main part of the file names (note that some parts may not make sense for a given data type and will consequently be left out) <project identifier>_<instrument>_<target/field>_<filter>_v<version nr> In addition, file name lengths should be kept to a maximum of 63 characters to ensure that files can be properly stored in the Archive.
    See below for some examples of names used in various ADP releases.

  • File types
    The following (sub) types are currently supported:
    Images (calibration/science): image.reduced, image.stacked, image.mosaic, image.mosaic.rgbcube, image.weight
    Spectra (science): spectrum.1d, spectrum.1dstack, spectrum.2d
    In addition any ancillary type (log, plot, etc.) is in principle supported; please contact us with an example of the product and we can assign the proper sub type.

  • Associations
    Associations between files can be specified by labeling the relevant files with the same number (or they can be described in words). The example below shows the first case.


Below are two example readme files, describing parts of the 30 Doradus ADP imaging release and the final GOODS FORS2 spectroscopy release.

  • ADP/30 Doradus (imaging)#filepath                                    filetype                assoc_id
    ADP_WFI_30Dor1_B-878_v1.0.fits                 image.reduced           1
    ADP_WFI_30Dor1_B-878_v1.0.weight.fits          image.weight            1
    ADP_WFI_30Dor1_Ha-856_v1.0.fits                image.reduced           2
    ADP_WFI_30Dor1_Ha-856_v1.0.weight.fits         image.weight            2
    ...                  
    ADP_WFI_30Dor2_Ha-856_v1.0.fits                image.reduced           6
    ADP_WFI_30Dor2_Ha-856_v1.0.weight.fits         image.weight            6
    ADP_WFI_30Dor4_V-843_v1.0.fits                 image.reduced           16
    ADP_WFI_30Dor4_V-843_v1.0.weight.fits          image.weight            16
    ADP_WFI_30Dor_RGBcube_v1.0.fits                image.mosaic.rgbcube
  • GOODS/FORS2 (spectroscopy)#filepath                                                  filetype            assoc_id
    GOODS_FORS2_GDS_J033227.72-275040.8_994852_v3.0.fits       spectrum.1d         1
    GOODS_FORS2_GDS_J033227.72-275040.8_994852_v3.0.spec.png   spectrum preview    1
    GOODS_FORS2_GDS_J033227.72-275040.8_v3.0.img.jpg           colour cutout       1
    ...
    GOODS_FORS2_GDS_J033224.02-274408.2_940129_v3.0.fits       spectrum.1d         20
    GOODS_FORS2_GDS_J033224.02-274408.2_940129_v3.0.spec.png   spectrum preview    20
    GOODS_FORS2_GDS_J033224.02-274408.2_v3.0.img.jpg           colour cutout       20<

If these types are not sufficient or unclear, please contact the VOS/ADP group at usd-help@eso.org, subject: EDP - ADP Submission.