Madrigal Metadata
Madrigal includes a number of tables, which provide information
about the contents of the database and other useful information.
These tables are listed below, with a list of the columns in each
table. The master of each table is an ASCII, comma delimited table.
All tables are stored in {madroot}/metadata. An example of each field is in
parentheses after the field
name.
- Database Site Table (siteTab.txt)- Contains a list of all
Madrigal Database sites. This table is hand-generated.
- Site ID (1) (one->)
- Site Name (Millstone Hill Observatory)
- Madrigal server (www.haystack.edu)
- Madrigal document root relative to server (madrigal)
- Madrigal CGI directory relative to server
(cgi-bin/madrigal)
- Madrigal servlet directory relative to server
(madrigal/servlets)
- Contact name (John M. Holt)
- Contact Address 1 (MIT Haystack Observatory)
- Contact Address 2 (Route 40)
- Contact Address 3 ( )
- Contact City (Westford)
- Contact State/Province (MA)
- Contact Postal Code (01886)
- Contact Country (USA)
- Contact Telephone (1-617-981-5624)
- Contact email (mailto:jmh@hyperion.haystack.edu) Multiple addresses may be listed if separated by semicolons.
- Experiment Table (expTab.txt) - Contains a list of all
experiments in the local Madrigal database. The table entry for
each individual experiment is stored in the appropriate experiment
directory in file expTab.txt. The full table for the local
database, also named expTab.txt, is generated by genTab, which
descends the experiment directory tree and concatenates the entries
for the individual experiments. The full table for all database
sites is generated by genTabAll, which visits each of the sites
listed in the Database Site table, retrieves expTab.txt and
contenates the retrieved files into expTabAll.txt. The experiment
ID is for indexing purposes and is constructed so that each
madrigal site may have up to 10,000,000 experiments. The local
experiment ID is an arbitrary number between 0 1nd 9,999,999. It is
meaningful only in the concatenated expTab.txt, and may change
whenever the tables are regenerated.
- Experiment ID (10000000*siteID+localExpID) (one->)
- Experiment URL
(http://www.haystack.edu/cgi-bin/madtoc/1997/mlh/03dec97g)
- Experiment Name (Wide Latitude Substorm Study)
- Site ID (1) (many<-)
- Start Date (19971203)
- Start Time (0113)
- End Date (19971205)
- End Time (1235)
- Instrument Code (30 = kinst)
- Security Code (0)
- Data Availability Table (dataTab.txt) - Contains a list of all
datasets in the local Madrigal database, with separate entries for
each day and data type (kindat) for which an experiment contains
data. The table entry for each individual experiment is stored in
the appropriate experiment directory in file dataTab.txt. The full
table for the local database, also named dataTab.txt, is generated
by genTab, which descends the experiment directory tree and
concatenates the entries for the individual experiments. The full
table for all database sites is generated by genTabAll, which
visits each of the sites listed in the Database Site table,
retrieves dataTab.txt and concatenates the retrieved files into
dataTabAll.txt.
- Day (8340) (many<-)
- Experiment ID (10000125) (many<-)
- Data Type (3001 = kindat) (many<-)
- Instrument Table (instTab.txt) - Contains a list of all
Instruments for which there is data in the database. This table, is
hand-generated and is consistent with the CEDAR Database list of
instrument codes.
- Instrument Code (30 = kinst) (one->)
- Instrument Mnemonic (mlh)
- Instrument Name (Millstone Hill Incoherent Scatter Radar)
- Latitude (42.5)
- Longitude (-71.9)
- Altitude in km above sea level (0.146)
- Contact name (John M. Holt)
- Contact Address 1 (MIT Haystack Observatory)
- Contact Address 2 (Route 40)
- Contact Address 3 ( )
- Contact City (Westford)
- Contact State/Province (MA)
- Contact Postal Code (01886)
- Contact Country (USA)
- Contact Telephone (1-617-981-5625)
- Contact email (mailto:jmh@chaos.haystack.edu)
- Instrument Parameter Table (instParmTab.txt) - Contains information
about what parameters are found in the data for any given instrument.
This data is used to support the global database query web page,
and is rebuild by updateMaster.
- Instrument Code (30 = kinst)
- Parameter mnemonic list (range rangei az1 az2 el1 el2 pl snp3 chisq mhdqc1 systmp systmi power tfreq popl dpopl ti dti tr dtr vo dvo ph+ dph+ pm dpm fa dfa pnrmd pnrmdi vdopp dvdopp)
- Madrigal/Cedar Parameter Table (parcods.tab) - Contains information
about what Madrigal or Cedar parameters are supported. Madrigal parameters
are a superset of Cedar parameters. If a Madrigal parameter has a parameter
code of 0, it cannot be stored in a Cedar file and is meant the be a calculated
value only. All Madrigal mnemonics must be unique. All non-zero parameter codes
must be unique, and are set by the Cedar standard.
The file parcodes.tab is not comma delimited, but instead is fixed length formatted.
- Parameter Code (may be zero) (columns 0-7)
- Description (columns 10-48)
- Int16Desc (columns 50-60)
- ScaleFactor (columns 62-68)
- Units (columns 70-77)
- Mnemonic (columns 81-100)
- Format (Now use C-style formatting) (columns 105-112)
- Width (columns 114-115)
- Category Id (see madCatTab.txt) (columns 118-120)
- Mnemonic has Html description (1 or 0) (columns 122-122)
- Err mnemonic has Html description (1 or 0) (columns 124-124)
- Madrigal Category Table (madCatTab.txt) - Contains information
about what categories Madrigal parameters belong in. Independent of
Cedar categories.
- Category id (integers, starting at 0)
- Category name
- Minimum parameter code (integer). Used only for codes not listed in
parcods.tab. If category doesn't have a range of codes, use -1.
- Maximum parameter code (integer). Used only for codes not listed in
parcods.tab. If category doesn't have a range of codes, use -1.
- Data Type Table (typeTab.txt) - Contains a list of all
datatypes (kindat) in the database. This table is hand-generated
and is consistent with the CEDAR Database list of kindat codes.
- Data Type Code (3001 = kindat) (one->)
- Data Type Brief Description (Basic Derived Parameters
(Ne,Ti,Te,Vi))
- Instrument Kindat Table (instKindatTab.txt) - Contains information
about what kindat codes are used with any given instrument.
This data is used to support the global database query web page,
and is rebuild by updateMaster.
- Instrument Code (30 = kinst)
- Kindat code list (3408 13204 13210 3001)
- File Table (fileTab.txt) - Contains a list of all madrigal
files in the database. The table entries for each individual
experiment are stored in the appropriate experiment directory in
file fileTab.txt. The full table for the local database, also named
fileTab.txt, is generated by genTab, which descends the experiment
directory tree and concatenates the entries for the individual
experiments. The full table for all database sites is generated by
genTabAll, which visits each of the sites listed in the Database
Site table, retrieves fileTab.txt and contenates the retrieved
files into fileTabAll.txt. Each file may contain only one kindat.
The category field is used to distinguish files which are of
historical interest only, e.g. a file which have been superseded by
a file with an improved electron density calibration. In some cases
there may be more than one up-to-date variant of a file, e.g. when
different analysis options have been chosen. In this case one of
these files is designated the default, and the others are
designated as variants. Typically a top-level interface to an
experiment would display links to default and variant files, but
not to history files.
- File Name (mil971203g.002) (one->)
- Experiment ID (10000125) (many<-)
- Data Type (3001 = kindat) (many<-)
- Category (1=default, 2=variant, 3=history, 4=real-time)
- Size of File (241920) (one->)
- Size of Catalog Record File (0) (one->)
- Size of Header Record File (0) (one->)
- Analyis/modify Date (19980101)
- Analyis/modify Time (115131)
- File processing status description (preliminary, final, or any other description)
- Permission flag: 0 for public, 1 for private
Revised: March 10, 2004