Differences

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

--- bufr.pm:bufrread_help [2010-02-01 12:12:39]
pals created
+++ bufr.pm:bufrread_help [2022-05-31 09:29:31] (current)
@@ Line 1: / Line 1: @@
 <code>
-Usage: /metno/local/bin/bufrread.pl <bufr file(s)> [options]
+Usage:
+      bufrread.pl <bufr file(s)>
+          [--ahl <ahl_regexp>]
+          [--all_operators]
+          [--bitmap]
+          [--codetables]
+          [--data_only]
+          [--filter <filter file>]
+          [--help]
+          [--nodata]
+          [--noqc]
+          [--on_error_stop]
+          [--optional_section]
+          [--outfile <filename>]
+          [--param <descriptor file>]
+          [--strict_checking n]
+          [--tableformat <BUFRDC|ECCODES>]
+          [--tablepath <path to BUFR tables>]
+          [--verbose n]
+          [--width n]
-Will print section 0-4 in BUFR messages in <bufr file(s)>.
+Options:
-Options (may be abbreviated, e.g. --h or -h for --help) are:
+       --ahl <ahl_regexp>
+                       Decode BUFR messages with AHL matching <ahl_regexp> only
+       --all_operators Show all operator descriptors when printing section 4
+       --bitmap        Display bit-mapped values on same line
+       --codetables    Use code and flag tables to resolve values when unit
+                       is [CODE TABLE] or [FLAG TABLE]
+       --data_only     Print section 4 (data section) only
+       --filter <filter file>
+                       Decode observations meeting criteria in <filter file> only
+       --help          Display Usage and explain the options used. For even
+                       more info you might prefer to consult perldoc bufrread.pl
+       --nodata        Do not print (nor decode) section 4 (data section)
+       --noqc          Do not decode quality control
+                       (or any descriptors following 222000)
+       --on_error_stop Stop processing as soon as an error occurs during decoding
+       --outfile <filename>
+                       Will print to <filename> instead of STDOUT
+       --optional_section
+                       Display a hex dump of optional section if present
+       --param <descriptor file>
+                       Display parameters with descriptors in <descriptor file> only
+       --strict_checking n n=0 (default) Disable strict checking of BUFR format
+                           n=1 Issue warning if (recoverable) error in
+                               BUFR format
+                           n=2 Croak if (recoverable) error in BUFR format.
+                               Nothing more in this message/subset will be decoded.
+       --tableformat   Currently supported are BUFRDC and ECCODES (default is BUFRDC)
+       --tablepath <path to BUFR tables>
+                       Set path to BUFR tables (overrides ENV{BUFR_TABLES})
+       --verbose n     Set verbose level to n, 0<=n<=6 (default 0). n=1 will
+                       show the tables loaded.
+       --width n       Set width of field used for data values to n characters
+                       (default is 15)
-        --codetables    Use code and flag tables to resolve values where unit
+    Options may be abbreviated, e.g. "--h" or "-h" for "--help".
-                        is [CODE TABLE] or [FLAG TABLE]
-        --data_only     Print section 4 (data section) only
-        --param <descriptor file>
-                        Decode parameters with descriptors in <descriptor file> only
-        --filter <filter file>
-                        Decode observations meeting criteria in <filter file> only
-        --bitmap        Display bit mapped values on same line
-        --noqc          Do not decode quality control
-                        (or any descriptors following 222000)
-        --outfile <filename>
-                        Will print to <filename> instead of STDOUT
-        --optional_section
-                        Display a hex dump of optional section if present
-        --width n       Set width of field used for data values to n characters
-                        (default is 15)
-        --strict_checking n n=0 (default) Disable strict checking of BUFR format
-                            n=1 Issue warning if (recoverable) error in
-                                BUFR format
-                            n=2 Croak if (recoverable) error in BUFR format.
-                                Nothing more in this message will be decoded.
-        --all_operators Show all operator descriptors when printing section 4
-        --tablepath <path to BUFR tables>
-                        Set path to BUFR tables (overrides ENV{BUFR_TABLES})
-        --verbose n     Set verbose level to n, 0<=n<=3 (default 0)
-        --help          Print this Usage
-You should probably set
+    To avoid having to use the "--tablepath" option, you are adviced to set
-        export BUFR_TABLES=/usr/local/emos/bufrtables
+    the environment variable BUFR_TABLES to the directory where your BUFR
-or use the --tablepath option.
+    tables are located (unless the default path provided by bufrread.pl
+    works for you). For tableformat ECCODES, se
+    <http://search.cpan.org/dist/Geo-BUFR/lib/Geo/BUFR.pm#BUFR-TABLE-FILES>
+    for more info on how to set "--tablepath" (or BUFR_TABLES).
-Each line in <descriptor file> should start with a BUFR descriptor (6 digits).
+    For option "--ahl" the <ahl_regexp> should be a Perl regular expression.
-Rest of line will be ignored. bufrread will extract values for these descriptors
+    E.g. "--ahl "ISS... ENMI"" will decode only BUFR SHIP (ISS) from
-only. If used together with --filter, <descriptor file> must contain all descriptors
+    CCCC=ENMI. This is the only case where a little knowledge of Perl might
-in <filter file>.
+    possibly be required when using the utility programs included in
+    Geo::BUFR.
-Using --filter will decode only those observations that meet one of the criteria in
+    For option "--param" each line in <descriptor file> should start with a
-<filter file> (and all of those criteria marked D!). Comments (starting with #) are
+    BUFR descriptor (6 digits). Rest of line will be ignored. bufrread.pl
-ignored. An example of a filter file is
+    will display values for these descriptors only.
-# All stations in WMO block 01
+    Using "--filter" will decode only those observations that meet one of
-D: 001001
+    the criteria in <filter file> (and all of those criteria marked D!).
+    Comments (starting with #) are ignored. An example of a filter file is
-D: 001001 001002
-895
-252
-D: 001011
-LF5U       # Ekofisk
-D!: 004004
-which decodes all observations with block number 01, two other specific wmo stations
+      D: 001001
-and one specific ship, all of which having hour (004004) equal to 6 or 7.
-If there is no value line after a descriptor line, it is enough that the observation
+      D: 001001 001002
-contains the descriptor(s), whatever the values are. So to extract all ship messages
+895
-from a BUFR synop file, the filter file should contain this single line only:
+ 252
+      D: 001011
+      LF5U       # Ekofisk
+      D!: 004004
+
-D: 001011
+    which decodes all observations with block number 01, two other specific
+    WMO stations and one specific ship, all of which having hour (004004)
+    equal to 6 or 7. If there is no value line after a descriptor line, it
+    is enough that the observation contains the descriptor(s), whatever the
+    values are. So to extract all ship messages from a BUFR file, the filter
+    file should contain this single line only:
+      D: 001011
+    If an error occurs during decoding (typically because the required BUFR
+    table is missing or message is corrupt), the BUFR message is skipped
+    with an error message printed to STDERR, and processing then continues
+    with the next BUFR message. You can change this default behaviour,
+    however, by setting "--on_error_stop".
-If an error occurs during decoding (typically because the required BUFR table is
-missing or message is corrupt) the message is skipped, and the number of errors
-is reported at end of output.
 </code>