ADC Data Submission Guidelines
To accompany the data, we request a document in ASCII which follows the format
used by the Centre de Données astronomique de Strasbourg (CDS). Not only does
preparing the document in this form make interchanges between the two data
centers easier, but CDS has written a substantial amount of software which
permits easy checking of the catalogs and automatic conversion to FITS format.
Although the description appears lengthy, we find it rather easy to follow.
The CDS standard is described in CDS Bulletin #44, January, 1994, p19. An
updated draft version is available via anonymous FTP at
adc.astro.umd.edu/pub/adc/docs/. A template for the document
with modifications covering the ADC needs is as follows:
CATEGORY/number Brief Title (First_Author+ YEAR) [required]
============================================================= [required]
Complete Title of Data Source [required]
which may continue on second line. [required]
Indented_Author I. N. (no comma between last name [required]
and initials)
<Journal_name, Volume_number, First_Page_Number (Year)> [required]
(use A&A abbreviations)
= NED/CDS BibCode (see journabb.txt and ref_code.txt) [required]
(if it exists)
Complete Long Title of Second Data Source [optional]
Author_1 A., Author_2 B., Author_3 C. [optional]
<Other_reference (Year)> [optional]
= NED/CDS BibCode (see journabb.txt and ref_code.txt) [optional]
(required only if data from more than one source are included)
... [optional repeats if needed]
==================================== [optional]
ADC_Keywords: see ADC_keyword.lis [required]
Mission_Name: see mission_names [required for mission data only]
Description: [required]
This describes the data in the catalog in general terms. [required]
It should allow the astronomer decide whether the data are [required]
useful for his/her purpose. In general the type of data [required]
and any pertinent details should be mentioned. Normally, [required]
it is not the abstract of the paper as it should not [required]
discuss results. [required]
Introduction: [optional documentation section]
Text providing more details than the Description that [optional]
will help the user of the data. It is not intended to [optional]
replace the printed paper. [optional]
File Summary: [required]
------------------------------------------------------------ [required]
FileName Lrecl Records Explanations [required]
------------------------------------------------------------ [required]
ReadMe 80 . This file [required]
filename.typ 00 000 *list all files as 8 [required]
char+extension [required]
file2.typ 00 000 description of data in file2 [required]
------------------------------------------------------------ [required]
*Note on extension: the extension is related to the format of
the file:
.dat for files containing data in plain ASCII form
.doc for files containing the documentation in plain
ASCII form
.fit for FITS files
.txt for plain ASCII text files
Note on filename.typ: [optional]
Text of note. [optional]
... [optional]
Objects: (include only if data refer to only a few objects) [optional]
---------------------------------------------------------- [optional]
RA (equinox) DEC Name(s) [optional]
---------------------------------------------------------- [optional]
00 00 00.000 00 00 00.0 name1 object = altern. name [optional]
00 00 00.000 00 00 00.0 *name2 object [optional]
---------------------------------------------------------- [optional]
Note on name2: [optional]
Note on name2 object. [optional]
See also: [optional]
CATID : superseded or other note, or related catalog [optional]
URL : note about this URL [optional]
Nomenclature Notes: [optional]
Necessary explanations for peculiar naming conventions. [optional]
Text describing filename.dat: [optional]
Describes the data file of following byte-by-byte [optional]
description. [optional]
Byte-by-byte Description of file: filename.dat [required]
------------------------------------------------------------ [required]
Bytes Format Units* Label Explanations [required]
------------------------------------------------------------ [required]
001-008 Fa.b --- label_1 *[x/y]!=null some words [required]
010-019 Fa.b --- label_2 some words (3) [required]
... [required]
------------------------------------------------------------ [required]
*Note on Units: SI units are required except for distance
Note on label_1: [optional]
Here a note to the column of data identified by * as the [optional]
first item of the explanations column. [optional]
or
Note (3): [optional]
Here a note to the column of data identified by (3) as the [optional]
last item of the explanations column. [optional]
Remarks: [optional]
This section gives details of catalog ingest, changes made [optional]
to the data, errors found and corrected, and other remarks [optional]
that are important for the user. [optional]
Acknowledgments: [optional]
Here any "courtesy of" and acknowledgements appear. [optional]
References: (required for papers referenced in document) [required]
Title, Year, Authors, Publication, Volume, First Page [required]
= NED/CDS BibCode (see journabb.txt and ref_code.txt) [required]
==============================================================[required]
(End) N. Paul Kuin [SSDOO/ADC] 1-May-1996 [required]
Each section header is left flush, starts with a capital letter and ends with a colon (:). The main text of the section is indented except for the long title and byte-by-byte descriptions. The indented text should have lines no longer than 72 characters. In the File Summary heading "Filename" must be indented at least one space.
There are standard lists for the "ADC_Keywords" , and the "Mission_Name" , and for some of the labels (see label.txt and lprefix.txt), units (SI) and symbols (see unitsym.txt and msubmsym.txt ) in the "Byte-by-byte Description". Also note the standardization of the section header names:
ADC_Keywords: Description: File Summary: Objects: See also: Nomenclature Notes: Byte-by-byte Description of file: Note: Remarks: Acknowledgments: References: (END)
where the capitalization and spacing and ending colon are important for automatic recognition.
The Byte-by-byte Description is required for each tabular data file; it is not required for plain text files without tabular structure.
The optional text sections describing the catalog should interleave the required sections in a natural way. In particular the Byte-by-byte Description table should be close to the text describing the same data and not in a group at the beginning or the end of the document.
The following is an example of a "ReadMe" file. However each catalog has its own needs. We are interested primarily in your lengthy tables. Shorter ones should not be included unless they are essential to understanding the catalog or major tables.
II/177 Near IR Photometry of a Sample of IRAS Point Sources (Fouque+ 1992)
================================================================================
Near Infrared Photometry of a Sample of IRAS Point Sources
Fouque P., Le Bertre T., Epchtein N., Guglielmo F., Kerschbaum F.
<Astron. Astrophys. Suppl. Ser. 93, 151 (1992)>
=1992A&AS...93..151F
================================================================================
ADC_Keywords: Mass loss; Photometry, classification; Stars, carbon
Description:
The results are given for the 516 sources that were observed from
La Silla (452 in the southern hemisphere, plus 64 in the range 0 to
20deg). For each source, the IRAS name is given followed by the epoch
of observation (with the convention given in note on epoch), the
J, H, K, L', M magnitudes that were obtained, then three classifications
based on IRAS Low Resolution Spectra (LRS), IRAS broad-band photometry
(VH) and the combination of IRAS broad-band photometry with the
near-infrared photometry (Val), and, finally, one association.
File Summary:
--------------------------------------------------------------------------------
FileName Lrecl Records Explanations
--------------------------------------------------------------------------------
ReadMe 80 . This file
intro.tex 80 105 latex description
main.dat 71 516 data from table 2 of reference
remarks.dat 64 14 comments on observations
--------------------------------------------------------------------------------
Byte-by-byte Description of file: main.dat
--------------------------------------------------------------------------------
Bytes Format Units Label Explanations
--------------------------------------------------------------------------------
2- 11 A10 --- ID IRAS PSC (Catalogue ) number
12 A1 --- Note [*] '*' when there is a note in table 1c of
the published paper (see remarks.dat)
14- 15 A2 --- Epoch *coded
17- 21 F5.2 mag Jmag ? Jmagnitude
23- 27 F5.2 mag Hmag ? Hmagnitude
29- 33 F5.2 mag Kmag ? Kmagnitude
35- 39 F5.2 mag L'mag ? L'magnitude
41- 45 F5.2 mag Mmag ? Mmagnitude
48- 49 A2 --- LRS IRAS/LRS Low resolution spectra classification
51- 54 A4 --- VH IRAS/VH broad band photometry classification
56- 58 A3 --- Val Classification based on IRAS/VH and authors
photometry (=1987A&AS...71...39E)
60- 71 A12 --- Assoc Name of associated optical source
--------------------------------------------------------------------------------
Note on Epoch:
Epoch label in main.dat
--------------------- -------------
13-07-89 to 20-07-89 1
10-08-89 to 16-08-89 2
08-09-89 to 17-09-89 3
12-06-90 to 14-06-90 4
01-07-90 to 05-07-90 5
25-04-91 to 03-05-91 10
Byte-by-byte Description of file: remarks.dat
--------------------------------------------------------------------------------
Bytes Format Units Label Explanations
--------------------------------------------------------------------------------
1- 10 A10 --- ID IRAS PSC number
12- 13 I2 --- LRS ? LRS classification
15- 18 A4 --- VH IRAS/VH broad band photometry classification
20- 22 A3 --- Val Classification based on IRAS/VH and authors
photometry (=1987A&AS...71...93E)
24- 33 A10 --- Assoc *Association
35- 64 A30 --- rem Comment on observation
--------------------------------------------------------------------------------
Note on Assoc:
PK = Catalog of Galactic Planetary Nebulae
See also:
J/A+AS/99/31 : Guglielmo et al., 1993, 106 new IR Carbon stars in
the IRAS Point Source Catalog =1993A&AS...99...31G
J/A+AS/106/397 : Kerschbaum and Hron, 1994, JHKL'M-photometry for 200 stars
=1994A&AS..106..397K
J/A+AS/113/441 : Kerschbaum, 1995, JHKL'M-photometry for 44
semi-regular variables =1995A&AS..113..441K
Historical Notes:
* 28-Jul-1992: table was kindly mailed by Thibaut Le Bertre
<lebertre@obspm.fr>, upon request by Michel Creze (CDS Director)
* 15-Nov-1995: ReadMe file standardized (F. Ochsenbein, CDS)
* 21-Aug-1996: note on epoch, remarks.dat, references added (J.A. Watko, ADC)
References:
source:
Fouque P., Le Bertre T., Epchtein N., Guglielmo F,, and Kerschbaum F. 1992,
Astron. Astrophys. Suppl. Ser. 93, 151 =1992A&AS...93..151F
LRS:
IRAS Science Team 1986, Astron. Astrophys. Suppl. Ser., 65, 607
=1986A&AS...65..607I
Volk K., Cohen M. 1989, Astron. J. 98, 931 =1989ApJ....98...93N
Val:
Epchtein N., Le Bertre T., Lepine J.R.D., Marques dos Santos P., Matsuura
O.T., Picazzio E. 1987, Astron. Astrophys. Suppl. Ser., 71, 39
=1988A&AS...71...39E
VH:
van der Veen W., Habing H.J. 1988, A&A 194, 125 =1988A&A...194..125V
================================================================================
(End) Michel Creze, Francois Ochsenbein [CDS] mod. J.A.Watko [ADC] 21-AUG-1996
Back to ADC Online Brochure...