NAME
C_CALDBINFO -- Checks whether a local CALDB is correctly installed for a user
USAGE
c_caldbinfo infomode
DESCRIPTION
This task will check and report back on whether a local Calibration Database
(Caldb) appears to be correctly set-up and accessible to a user. The level of
checking and detail of the reporting depend upon the user-defined parameters
infomode and chatter as described below.
Any error messages returned by this task indicate that the local Caldb is not
correctly set-up or accessible to the user. This is likely to prevent a number
of ftools from using the Caldb. In such cases users should:
- first
-
re-run c_caldbinfo, but with the chatter flag set high (eg chatter=30). Hopefully
the resultant informational messages will partially illuminate the problem.
- second
-
check the steps outlined in the Caldb Installation Guide (CAL/GEN/94-004), and/or
contact their local Caldb Manager
- finally
-
if problems remain with the local Caldb set-up or allowing the user to
obtaining access to the local Caldb, then e-mail
caldbhelp@athena.gsfc.nasa.gov
(including the results obtained when c_caldbinfo is run at high chatter)
PARAMETERS
- infomode [string]
-
This parameter controls to what level the putative Caldb set-up is tested.
For infomode=BASIC, the task simply checks that the two environment variables
(or logicals under VMS) required for the Caldb are defined.
For infomode=INST, in addition to performing the checks for infomode=BASIC,
the tasks it can find entries for a user-defined mission/instrument combination
in the Caldb Configuration file. At high chatter, the location of the relevant
files and directories are reported upon.
- mission [string]
-
The name of the mission for which the Caldb Configuration file is to be
searched. This parameter is only required when infomode=INST.
- instrument [string]
-
The name of the instrument for which the Caldb Configuration file is to be
searched. This parameter is only required when infomode=INST.
- (chatter = 9) [integer]
-
Flag to indicate how chatty the task is at execution. A value of 9 is the
default, with lower/higher values producing quieter/verbose output respectively.
A value of chatter=0 gives totally silent running, with the exception of
error messages. For all values of chatter, a message will be written to STDERR
if any errors are encountered.
EXAMPLES
1. Do a basic (but silent) check that the Caldb is set-up
ca> c_caldbinfo infomode=BASIC chatter=0
2. Do a basic check that the Caldb is set-up, but reporting detailed
information to STDOUT
ca> c_caldbinfo infomode=BASIC chatter=20
3. Silently check that the Caldb is set-up & accessible for a given
mission/instrument combination
ca> c_caldbinfo infomode=INST chatter=0 mission=XTE instrument=PCA
BUGS
none known
SEE ALSO
c_crcif
LOG OF SIGNIFICANT CHANGES
- v1.0.0 (1998 Feb)
-
First public release
PRIMARY AUTHOR
Lorraine Breedon
HEASARC
NASA/GFSC
http://heasarc.gsfc.nasa.gov/cgi-bin/ftoolshelp
(301) 286-1364
CATEGORY
98Feb ftools.caltools