Differences

This shows you the differences between two versions of the page.

--- bufr.pm:bufrencode_help [2010-02-02 10:40:33]
pals created
+++ bufr.pm:bufrencode_help [2022-05-31 09:29:31] (current)
@@ Line 1: / Line 1: @@
 <code>
+Usage:
+      bufrencode.pl --data <data file> --metadata <metadata file>
+          [--outfile <file to print encoded BUFR message to>]
+          [--strict_checking n]
+          [--tableformat <BUFRDC|ECCODES>]
+          [--tablepath <path to BUFR tables>]
+          [--verbose n]
+          [--help]
-Will create a BUFR message printed to STDOUT based on data and metadata
+Options:
-in files <data file> and <metadata file> respectively.
+       --help               Display Usage and explain the options. Almost
+                            the same as consulting perldoc bufrencode.pl
+       --outfile <filename> Will print the encoded BUFR message to <filename>
+                            instead of STDOUT
+       --strict_checking n  n=0 Disable strict checking of BUFR format
+                            n=1 Issue warning if (recoverable) error in
+                                BUFR format
+                            n=2 (default) Croak if (recoverable) error in BUFR format.
+                                Nothing more in this message will be encoded.
+       --tableformat        Currently supported are BUFRDC and ECCODES (default is BUFRDC)
+       --tablepath <path to BUFR tables>
+                            If used, will set path to BUFR tables. If not
+                            set, will fetch tables from the environment
+                            variable BUFR_TABLES, or if this is not set:
+                            will use DEFAULT_TABLE_PATH_<tableformat>
+                            hard coded in source code.
+       --verbose n          Set verbose level to n, 0<=n<=6 (default 0).
+                            Verbose output is sent to STDOUT, so ought to
+                            be combined with option --outfile
-Usage: /metno/local/bin/bufrencode.pl -d <data file> -m <metadata file>
+  Required options:
-or     /metno/local/bin/bufrencode.pl --data <data file> --metadata <metadata file>
+   --metadata <metadata file>:
+    For the metadata file, use this as a prototype and change the values as
+    desired:
-Options:
+      BUFR_EDITION  4
-      --help
+      MASTER_TABLE  0
-  Will print this help message and then exit
+      CENTRE  88
-      --outfile <filename>
+      SUBCENTRE  0
-  Will print encoded BUFR messages to <filename> instead of STDOUT
+      UPDATE_SEQUENCE_NUMBER  0
-      --verbose n
+      OPTIONAL_SECTION  0
-  Set verbose level to n, 0<=n<=3 (default 0). Verbose output is sent STDOUT,
+      DATA_CATEGORY  0
-  so ought to be combined with option --outfile
+      INT_DATA_SUBCATEGORY  2
-      --tablepath <path to BUFR tables>
+      LOC_DATA_SUBCATEGORY  255
-  If used, will set path to BUFR tables. If not set, will fetch tables
+      MASTER_TABLE_VERSION  14
-  from the environment variable BUFR_TABLES, or if this is not set: will use
+      LOCAL_TABLE_VERSION  0
-  /usr/local/lib/emos/bufrtables/
+      YEAR  2008
+      MONTH  9
+      DAY  1
+      HOUR  6
+      MINUTE  0
+      SECOND  0
+      OBSERVED_DATA  1
+      COMPRESSED_DATA  0
+      DESCRIPTORS_UNEXPANDED  308004 012005 002002
+    For BUFR edition < 4, replace the lines INT_DATA_SUBCATEGORY,
+    LOC_DATA_SUBCATEGORY, YEAR and SECOND with new lines DATA_SUBCATEGORY
+    and YEAR_OF_CENTURY (the order of lines doesn't matter).
+   --data <data file>:
+    For the data file, use the same format as would result if you did run on
+    the generated BUFR message
+        bufrread.pl <bufr file> --data_only | cut -c -31
-For the metadata file, use this as prototype and change the values as desired:
+    or if you use bufrread.pl with "--width n", replace 31 with n+16. For
+    example, the file might begin with
-BUFR_EDITION  4
+  001195          Newport
-MASTER_TABLE  0
+  005002            51.55
-CENTRE  98
+  006002            -2.99
-SUBCENTRE  0
+  004001             2008
-UPDATE_NUMBER  0
+    ...
-OPTIONAL_SECTION  0
-DATA_CATEGORY  0
-INT_DATA_SUBCATEGORY  0
-LOC_DATA_SUBCATEGORY  255
-MASTER_TABLE_VERSION  13
-LOCAL_TABLE_VERSION  1
-YEAR  2008
-MONTH  9
-DAY  1
-HOUR  6
-MINUTE  0
-SECOND  0
-OBSERVED_DATA  1
-COMPRESSED_DATA  0
-DESCRIPTORS_UNEXPANDED  308004 012005 002002
-For BUFR edition < 4, replace the lines INT_DATA_SUBCATEGORY,
+    Every time a new line starting with the number 1 is met, a new subset
-LOC_DATA_SUBCATEGORY, YEAR and SECOND with new lines DATA_SUBCATEGORY
+    will be generated in the BUFR message. Lines not starting with a number
-and YEAR_OF_CENTURY (the order of lines doesn't matter).
+    are ignored.
-For the data file, use the same format as would result if you did run
+    For missing values, use 'missing' or stop the line after the BUFR
-on the generated BUFR message
+    descriptor.
-    bufrread.pl <bufr file> --data_only | cut -c -31
-(or if you use bufrread.pl with --width n, replace 31 with n+16).
-For example, the file might begin with
-  001195          Newport
+    Associated values should use BUFR descriptor 999999, and operator
-  005002            51.55
+    descriptors 22[2345]000 and 23[2567]000 should not have a value, neither
-  006002            -2.99
+    should this line be numbered, e.g.
-  004001             2008
-...
-Every time a new line starting with the number 1 is met, a new subset will be
+  011002          missing
-generated in the BUFR message. Lines not starting with a number are ignored.
+  031002              160
+  031031                0
+    ...
-For missing values, use 'missing' or stop the line after the BUFR descriptor.
+    To encode a NIL subset, all delayed replication factors should be
+    nonzero, and all other values set to missing except for the descriptors
+    defining the station.
-Associated values should use BUFR descriptor 999999.
+    Options may be abbreviated, e.g. "--h" or "-h" for "--help"
-To encode a NIL subset, all delayed replication factors should be set to 1, and
-all other values set to missing except for the descriptors defining the station.
 </code>