ADDING NEW DATA TYPES TO THE HIRES CDF WEB SITE

(Note: HIRES currently running on kodiak - 05/11/2005)

To add a new datatype to the Hires CDF website we need to have the following information, IDL code and plot config files:

  1. Datatype name, e.g. DCMAG, EES, SES, EEB.

  2. Short text description of the data type, to be displayed in the web page listing.

  3. An IDL procedure which can be called by cdfhires.pro to generate the CDF file. The requirements for this procedure are detailed in the comments to the cdfhires.pro procedure. The same proceture may produce more than one data type: the procedure should accept one argument, which is a string with the name of the data type. If necessary, it is simple to write a wrapper around IDL code provided by a scientist to fit the requirements.

  4. An SDT plot configuration which can be used by sdt_batch to determine all the data quantities that need to be decommutated before IDL is called to run cdfhires.pro.

  5. A list of APIDs required to generate the CDF, to be sent to whichfiles.

  6. The minimum and maximum length time intervals upon which the IDL procedure can be run to generate this type of CDF.

The procedure to add the new datatype is as follows:

  1. The IDL procedure should be placed in the Codemanager system, in the src/idlUtil/fast directory and make install should be run.

  2. The plot configuration should be placed in the /disks/fast/software/config/PlotConfigs directory.

  3. The hires_cdf.cfg file should be updated to include a new line for this data type, where the above-specified information simply needs to be entered in the proper format. All columns are whitespace separateed. Only the last colum may contain spaces, and the whole text of the last column must be single quoted.
    NOTE: The availability column in the hires_cdf.cfg file is reserved for data quantites which need more specific availablility queries than provided by whichfiles when it is passed a list APIDs. Currently I have just a semi-descriptive placeholder word in this column for each data type.

PARTIAL ANNOTATED LIST OF FILES RELATED TO THE HIRES CDF PRODUCTION SYSTEM

Files In Codemanager:

src/archive/

hires_cdf.ksh

Generates the CDF files, given a time range & datatype

hires_ustatus.pl

Registers a new user's email

hiresd.pl

Daemon which reads the request queue, calls hires_cdf, and emails user when done.


src/idlUtil/fast/

cdfhires.pro

the IDL pro called by sdt batch -- input parameters determine which .pro will be called to process the data.

*.pro

IDL scripts named in hires_cdf.cfg to generate specific datatypes.


Currently the web site runs from the integration Codemanager workspace.

PERL/CGI scripts:

/disks/plasma2/www/htbin/fastcgi/hires/

request.cgi

Perl script which generates request page and confirmation page.

signup.cgi


confirm.cgi


HTML files:

/disks/plasma2/www/fast/hires/

Config Files:

/disks/plasma2/www/fast/hires/config

hires_cdf.cfg

list of CDF data types

hires_roadmap.doc

this file.


/disks/fast/software/config/PlotConfigs

Uicfg.*

SDT plot configs referenced in hires_cdf.cfg

Database files for hires system - written to and read by hires processes:

/disks/plasma2/www/fast/hires/config/

hiresd.pid

created by hiresd -- don't edit by hand!


/disks/plasma2/www/fast/hires/config/db/

queue.db

requests waiting to be processed -- hires_cdf should be at work on the request in the top line. When done, will copy line to processed.db along with success status and hires_cdf pid.

whichfiles.lock

flock on this file ensures no parallel access to whichfiles from this website -- for sybase license


Log Files:

/disks/plasma2/www/fast/hires/config/

debug

error output from hiresd process


/disks/juneau/www/TEMPLOGS/hires/

hireslog_PID

log file for hires_cdf process corresponding to PID.
trouble copying the lzp files would show up here.


/home/lzp/hires/

errUI_PID
outUI_PID
errfast_PID
outfast_PID
errdqh_PID
outdqh_PID
errIDL.cdfhires.pro_PID
outIDL.cdfhires.pro_PID

SDT and IDL output associated with hires_cdf PID. Trouble with the data file integrety, instrument mode, or with the IDL scripts would show up in these files. All these files can be useful for debugging the IDL scripts which generate the CDF files.


/disks/plasma2/www/fast/hires/config/db/

processed.db

Log of all requests processed listing requesting user's email, datatype, options, status and hires_cdf PID