Home| superdarn| rfc| RFC0002

RFC: 0002

Title

Filename Format Definition

Author

R.J.Barnes

Summary

A proposal for modifying the format of SuperDARN filenames so that the user can immediately identify start time of the data contained within a file.

Description

1. Introduction

The original specification for SuperDARN filenames was as follows:

yymmddhhi[c].ttt
yyTwo digit year (83-99)
mmTwo digit month of year (01-12)
ddTwo digit day of month (01-31)
hhTwo digit hour of day (00-23)
iStation identifier (eg. g, k ,t w, etc.)
cAn optional single character suffix appended if more than one file was opened during a given hour (A-Z)
tttA three letter filetype (fit, inx, dat, smr, etc.)

In 1999 the two digit year specification was replaced by a full four digit year to deal with the millenium:

yyyymmddhhi[c].ttt

A typical set of filenames would look like:

2001012900k.fit
2001012900kA.fit
2001012902k.fit
2002111412g.dat

Due to the rapid increase in the number of radars it is apparent that the single letter radar identifier can no longer be used. Consequently the filename format must be changed, and it is logical to take advantange of this opportunity by making the filename format easier to understand.

2. Proposed Filename Format

The new filename format proposed is as follows:

yyyymmdd.hhMM.ss.iii.tttt
yyyyFour digit year (eg. 2004)
mmTwo digit month of year (01-12)
ddTwo digit day of month (01-31)
hhTwo digit hour of day (00-23)
MMTwo digit minute of hour (00-59)
ssTwo digit second of minute (00-59)
iiiRadar identifier string (eg. kap, sas)
ttttFilename type (eg. raw, fit, fitacf, rawacf)

A typical set of filenames in the new format would look like:

20010129.0000.00.kap.fitacf
20010129.0021.07.kap.fitacf
20010129.0200.00.kap.fitacf
20021114.1200.00.gbr.rawacf
2.1 Concatenated Files

Often the user will need to concatenate together multiple files when working on longer periods of data. Newer versions of the software allow the user to pick any arbitrary name for the concatenated files, but for convenience it is recommended that the following format is used:

yyyymmdd.hhMM.ss.LL.iii.tttt.C
yyyyFour digit year (eg. 2004)
mmTwo digit month of year (01-12)
ddTwo digit day of month (01-31)
hhTwo digit hour of day (00-23)
MMTwo digit minute of hour (00-59)
ssTwo digit second of minute (00-59)
LLlength in hours of the interval of data
iiiRadar identifier string (eg. kap, sas)
ttttFilename type (eg. raw, fit, fitacf, rawacf)
2.2 Daily Files

For convenience, a special shortened version of a filename can be used for files containing an entire day of data. This short hand version is much easier to type:

yyyymmdd.hhMM.ss.iii.tttt
yyyyFour digit year (eg. 2004)
mmTwo digit month of year (01-12)
ddTwo digit day of month (01-31)
iiiRadar identifier string (eg. kap, sas)
ttttFilename type (eg. raw, fit, fitacf, rawacf)

A typical set of filenames in this format would look like:

20010129.kap.grd
20010129.kap.grd
20010129.kap.grd
20021114.gbr.grd
2.3 Global and Hemispheric Files

In some cases a SuperDARN data file contains data from the entire array or from one hemisphere. In this case the station identifier suffix is omitted. For files containing either one hemisphere or another this should be indicated by including the additional suffix "N", "north", "S" or "south" as shown below. Either the full filename specification or the shortened daily file format can be used as appropriate:

yyyymmdd[.hhMM.ss][.LL][.HHHH].ttt
yyyyFour digit year (eg. 2004)
mmTwo digit month of year (01-12)
ddTwo digit day of month (01-31)
hhTwo digit hour of day (00-23)
MMTwo digit minute of hour (00-59)
ssTwo digit second of minute (00-59)
LLlength in hours of the interval of data
HHHHHemisphere type (eg. north, N, south or S)
ttttFilename type (eg. map)

A typical set of filenames in this format would look like:

20010129.grd
20010129.0030.00.map
20010129.0030.00.12.map
20010129.N.map
20010129.north.map
20010129.S.map

References

RFC #0003

History

2004/06/01 Initial Revision.
2004/06/08 Extended definitions to deal with whole day, hemispheric or global files.