Diff for "HKTelTimAve"

Differences between revisions 1 and 12 (spanning 11 versions)

Housekeeping Telemetry Time Averaging

The Housekeeping Telemetry Time Averaging is calculated from level 0 housekeeping day file data. The mean, maximum, minimum, and standard deviation are calculated. An instruction file is created to specify range of time, keywords, output drms series name, author, and owner.

Create Instruction file

The basic format of the instruction file is shown below.

##########  Template Instruction File Format  ##################
###comments can be added after # at beginning of line
TemplateName:<name of template file. Use for filename seriesname.template>
SeriesName:<name of dataseries to create or use>
Description:<description of series in quotes>
Author:<name in quotes>
Owner:<name in quotes>
Interval:<in seconds only>
keyword:<apid in decimal format>,<long keyword name>,<user created character name-not restricted size>
.
.
.
keyword:<apid in decimal format>,<long keyword name>,<user created character name-not restricted size>

An example instruction file is shown below.

###### Example 1 using apid 18 temperature values using users created names for short keyword name
TemplateName:hmi.temp_summary_usernames.template
Seriesname:hmi.temp_summary
Description:"Temperature Statistics using usernames from HMI Housekeeping - Thermal/PS voltage packet"
Author:"rock"
Owner:"rock"
Interval:600
keyword:18, HMI_TS19_OPT_INSIDE_FRONT,  HTS19_INSIDE_FRONT
keyword:18, HMI_TS21_OPT_NEAR_CEB_INT,  HTS21_NEAR_CEB
keyword:18, HMI_TS15_OVN_PREAMP,        HTS15_OVEN_PREAMP
###### End Example 1

Create Maxium, Minimum, Mean and Standard Deviation JSD file

The create mean, maximum, minimum, and standard deviation jsd(cm3sd_jsd.pl) script is use to create the output drms series in DRMS using each keywords in the instruction file to create a keyword with a MAX, MIN, MEAN, and SD suffix that is a float. There will be T_START and T_START_step ( Interval value), T_START_epoch keywords auto created to represent the start packet time and interval covered in seconds. The T_START keyword will be the index. The T_START and T_START_epoch values will use UTC in units field. T_START_step will use the interval value in the template instructions file where the interval value is in seconds. The time interval or range is use to create a step in the slotted drms series. The author and owner are used to create the corresponding values in output drms series. This script does attempt to locate errors in instruction file and displays error messages.

An example jsd created based on the example instruction is shown below.

#====Global Series Information ==============
SeriesName:  hmi.temp_summary
Description: "Temperature Statistics from HMI Housekeeping - Thermal/PS
voltage packet"
Author:      "rock"
Owner:       "rock"
Unitsize:    1
Archive:     0
Retention:   0
Tapegroup:   0
Index:       T_START
#== Keywords Series Information ==============
Keyword:T_START,time,ts_eq,record,TSEQ_EPOCH,2,UTC,"T_START"
Keyword:T_START_epoch,time,constant,record,TSEQ_EPOCH,2,UTC,"T_START_epoch"
Keyword:T_START_step,float,constant,record,600,%f,"600 sec","T_START_step"
Keyword:HTS21_NEAR_CEB_MIN,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_MIN"
Keyword:HTS21_NEAR_CEB_MAX,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_MAX"
Keyword:HTS21_NEAR_CEB_MEAN,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_MEAN"
Keyword:HTS21_NEAR_CEB_SD,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_SD" 
.
.
.

An example of running script is shown below. The isf= is followed by path to the instruction file. Some example instruction files are in software repository at $HOME/cvs/TBL_JSOC/lev1/instruction_file/su_carl.

 cm3sd_jsd_file.pl isf=/home/carl/cvs/TBL_JSOC/lev1/instruction_file/su_carl/hmitest1200_thermal_template.txt

The environment variable in script, HK_CM3SD_JSD_DIRECTORY, is defined at top of script. The jsd is created in the location defined in script. The jsd currently is created in the prod directory as shown below.

#PRODUCTION SETTINGS to send jsd files to production directory
$ENV{'HK_CM3SD_JSD_DIRECTORY'}="$hm/cvs/TBL_JSOC/lev1/hk_jsd_file/prod";
#USER SETTING to send jsd files to user directory 
#turn off production by commenting out, turn on what is need below
#su_carl setting for test creating instruction file.
#$ENV{'HK_CM3SD_JSD_DIRECTORY'}="$hm/cvs/TBL_JSOC/lev1/hk_jsd_file/su_carl";
#su_rock setting for test creating instruction file.
#$ENV{'HK_CM3SD_JSD_DIRECTORY'}="$hm/cvs/TBL_JSOC/lev1/hk_jsd_file/su_rock";

Load Maxium, Minimum, Mean and Standard Deviation in DRMS Data Series

The load mean, maximum, minimum, and standard deviation executable(load_m3sd) is use to get keyword data from housekeeping day file and calculate values based on time interval and keywords specified in instruction file.

Back to ["HMIModuleTable"]
Back to FrontPage

-  ⇤ ← Revision 1 as of 2009-10-24 06:33:05 → 
  Size: 1756
  Editor: yeti
  Comment:
+   ← Revision 12 as of 2009-10-24 07:31:08 → ⇥
  Size: 5078
  Editor: yeti
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 5:
-The create mean, maximum, minimum, and standard deviation jsd(cm3sd_jsd.pl) script is use to create the output drms series in DRMS using each keywords in the instruction file to create a keyword with a MAX, MIN, MEAN, and SD suffix that is a float. The time interval or range is use to create  step in the slotted drms series. The author and owner are used to create the corresponding values in output drms series. This script does attempt to locate errors in instruction file and displays error messages.
-Line 7:
+Line 6:
-===== Module Inputs =====
 . List inputs here
+===== Create Instruction file  =====
The basic format of the instruction file is shown below.
-Line 10:
+Line 9:
-===== Module Outputs =====
 . List outputs here
+{{{
##########  Template Instruction File Format  ##################
###comments can be added after # at beginning of line
TemplateName:<name of template file. Use for filename seriesname.template>
SeriesName:<name of dataseries to create or use>
Description:<description of series in quotes>
Author:<name in quotes>
Owner:<name in quotes>
Interval:<in seconds only>
keyword:<apid in decimal format>,<long keyword name>,<user created character name-not restricted size>
.
.
.
keyword:<apid in decimal format>,<long keyword name>,<user created character name-not restricted size>
}}}
-Line 13:
+Line 25:
-===== Cadence =====
 . Indicate nominal cadence on which module is run
+An example instruction file is shown below.
-Line 16:
+Line 27:
-===== Archive =====
 . Indicate if/when products are archived
+{{{
###### Example 1 using apid 18 temperature values using users created names for short keyword name
TemplateName:hmi.temp_summary_usernames.template
Seriesname:hmi.temp_summary
Description:"Temperature Statistics using usernames from HMI Housekeeping - Thermal/PS voltage packet"
Author:"rock"
Owner:"rock"
Interval:600
keyword:18, HMI_TS19_OPT_INSIDE_FRONT,  HTS19_INSIDE_FRONT
keyword:18, HMI_TS21_OPT_NEAR_CEB_INT,  HTS21_NEAR_CEB
keyword:18, HMI_TS15_OVN_PREAMP,        HTS15_OVEN_PREAMP
###### End Example 1 
}}}
-Line 19:
+Line 41:
-===== Options =====
 . Indicate if there are any options when running the code
-Line 22:
+Line 42:
-===== Overall Status of Module =====
 . Indicate estimate of percentage complete for the module
+===== Create Maxium, Minimum, Mean and Standard Deviation JSD file  =====
The create mean, maximum, minimum, and standard deviation jsd(cm3sd_jsd.pl) script is use to create the output drms series in DRMS using each keywords in the instruction file to create a keyword with a MAX, MIN, MEAN, and SD suffix that is a float. There will be T_START and T_START_step ( Interval value), T_START_epoch keywords auto created to represent the start packet time and interval covered in seconds. The T_START keyword will be the index. The T_START and T_START_epoch values will use UTC in units field. T_START_step will use the interval value in the template instructions file where the interval value is in seconds. The time interval or range is use to create a step in the slotted drms series. The author and owner are used to create the corresponding values in output drms series. This script does attempt to locate errors in instruction file and displays error messages.
-Line 25:
+Line 45:
-===== Status of Code =====
 . Name heritage or percent complete for Basic Code
+An example jsd created based on the example instruction is shown below.
{{{
-Line 28:
+Line 48:
-===== Status of DRMS module =====
 . Indicate status of DRMS module version of module
+#====Global Series Information ==============
SeriesName:  hmi.temp_summary
Description: "Temperature Statistics from HMI Housekeeping - Thermal/PS
voltage packet"
Author:      "rock"
Owner:       "rock"
Unitsize:    1
Archive:     0
Retention:   0
Tapegroup:   0
Index:       T_START
#== Keywords Series Information ==============
Keyword:T_START,time,ts_eq,record,TSEQ_EPOCH,2,UTC,"T_START"
Keyword:T_START_epoch,time,constant,record,TSEQ_EPOCH,2,UTC,"T_START_epoch"
Keyword:T_START_step,float,constant,record,600,%f,"600 sec","T_START_step"
Keyword:HTS21_NEAR_CEB_MIN,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_MIN"
Keyword:HTS21_NEAR_CEB_MAX,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_MAX"
Keyword:HTS21_NEAR_CEB_MEAN,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_MEAN"
Keyword:HTS21_NEAR_CEB_SD,int,variable,record,DRMS_MISSING_VALUE,%d,none,"HTS21_NEAR_CEB_SD" 
.
.
.
}}}
-Line 31:
+Line 72:
-===== Issues needing resolution =====
+An example of running script is shown below. The isf=  is followed by path to the instruction file. Some example instruction files are in software repository at $HOME/cvs/TBL_JSOC/lev1/instruction_file/su_carl.
-Line 33:
+Line 74:
-  * List issues that still need to be resolved
  * Describe as many as you like
+{{{
 cm3sd_jsd_file.pl isf=/home/carl/cvs/TBL_JSOC/lev1/instruction_file/su_carl/hmitest1200_thermal_template.txt
}}}
-Line 36:
+Line 78:
-===== Responsible scientist =====
 . Give name of local coordinator for development of this module
-Line 39:
+Line 79:
-===== Remarks =====
+The environment variable in script, HK_CM3SD_JSD_DIRECTORY, is defined at top of script. The jsd is created in the location defined in script. The jsd currently is created in the prod directory as shown below.
{{{
#PRODUCTION SETTINGS to send jsd files to production directory
$ENV{'HK_CM3SD_JSD_DIRECTORY'}="$hm/cvs/TBL_JSOC/lev1/hk_jsd_file/prod";
#USER SETTING to send jsd files to user directory 
#turn off production by commenting out, turn on what is need below
#su_carl setting for test creating instruction file.
#$ENV{'HK_CM3SD_JSD_DIRECTORY'}="$hm/cvs/TBL_JSOC/lev1/hk_jsd_file/su_carl";
#su_rock setting for test creating instruction file.
#$ENV{'HK_CM3SD_JSD_DIRECTORY'}="$hm/cvs/TBL_JSOC/lev1/hk_jsd_file/su_rock";
}}}


===== Load Maxium, Minimum, Mean and Standard Deviation in DRMS Data Series  =====
The load mean, maximum, minimum, and standard deviation executable(load_m3sd) is use to get keyword data from housekeeping day file and calculate values based on time interval and keywords specified in instruction file.
-Line 43:
+Line 97:
-----