Below you will find a toolkit of BUFR handling programs used actively at met.no, with examples of use and complete source code. Hopefully this will demonstrate the power of Geo::BUFR as well as providing potential users of Geo::BUFR an easy start. The first 5 programs are included in the CPAN Geo::BUFR distribution (will be installed in the
bin subdirectory of the installation directory).
A line consisting solely of three dots (…) in the examples of output from running the programs, marks that a (not so interesting) part of the output has been left out.
Notes to users outside met.no:
--tablepathto tell in which directory you keep your BUFR table files. Alternatively, you can set the environment variable BUFR_TABLES, or you can change the value of the constant
DEFAULT_TABLE_PATHin the source code of the utility programs (possibly you might want to change the values of
Decodes and prints section 0-4 in BUFR messages in input file(s). If the BUFR message is contained in a WMO bulletin, will also print WMO ahl.
Example: Executing bufrread.pl without arguments
Example: buffread.pl --help
Example: Processing a file containing several BUFR SYNOP bulletines, with no options set
Example: Same as above, but with options --param and --data_only set
Example: Processing a BUFR TEMP message with option --codetables set (to resolve code and flag values)
Example: Processing a BUFR message containing operators 222000 and 223000 with option --bitmap set (to display bitmapped entities on same line)
Example: Processing a BUFR message containing associated fields and change scale and data width operators
Example: Same as above, but with options --all_operators and --data_only set
Example: Processing a file containing BUFR BUOY bulletins with recoverable formatting errors in the BUFR messages, with option --strict_checking set
Displays information in BUFR tables.
Example: Executing bufrresolve.pl without arguments
Example: bufrresolve.pl --help
Example: Executing bufrresolve.pl on a table D descriptor (309052)
Example: Same as above, but with option --partial
Example: Same as above, but with option --simple
Example: Executing bufrresolve.pl on a sequence of descriptors with option --noexpand
Example: Showing content of code table (option --code)
Example: Resolving flag value (option --flag)
Encode a BUFR message based on data and metadata text files.
Example: Executing bufrencode.pl without arguments
Example: bufrencode.pl --help
Example: Encoding a 2 subset BUFR SYNOP message
Encode BUFR message(s) based on a text file matching what you would get by running bufrread.pl on the resulting BUFR file. This might be a handy alternative to bufrencode.pl for encoding new BUFR messages: start with a similar BUFR message you know is correctly formatted, run bufrread.pl on this, edit the output as desired, and using this as input to bufr_reencode.pl.
Example: Executing bufr_reencode.pl without arguments
Example: bufr_reencode.pl --help
Example: Encoding a single subset BUFR SYNOP message
bufralter.pl provides an even easier way to do some basic manipulation of BUFR messages than does bufr_reencode.pl (although much more restricted in what changes are possible). Besides, bufralter.pl has the nice feature of not touching the text between the BUFR messages. This might be handy if you for example have a file with WMO bulletins and want to do some changes in the BUFR messages without affecting or losing the WMO bulletin envelopes.
Example: Executing bufralter.pl without arguments
Example: bufralter.pl --help
Example: Altering a single subset BUFR SYNOP message, by changing value of hour, minute and temperature in section 4, changing update sequence number and changing version number for master table and local table.
A BUFR toolkit wouldn't be complete unless you have a way to dump the contents of BUFR files in a way which requires no prior knowledge whatsoever of the BUFR format. Therefore, the program bufrdump.pl is included even though it actually does not employ Geo::BUFR.pm, but rather is a wrapper around a Fortran program (named bufrdump) which uses the ECMWF libbufr library for the BUFR decoding. The reason for this choice was that for this particular program speed might be important (expecting users to dump huge BUFR files and grep'ing on the output), besides the fact that the main part of the program would be equally boring to code whether in Fortran or Perl.
The parameters are dumped in a
name=value fashion according to what most users at met.no expects (see Parametere i Kvalobs-databasen), e.g.
TA=-9.3 for temperature at 2 m equal to -9.3 Celsius. If your users are accustomed to other symbols and/or units, this should be rather easy to modify in source code of bufrdump.F.
So far dumping of BUFR SYNOP, TEMP, AMDAR and BUOY have been implemented (probably works also for PILO, BATHY and TESAC). More observation types are likely to be included in the future.
Example: Executing bufrdump.pl without arguments
Example: bufrdump.pl --help
Example: Dumping a multisubset multimessage BUFR SYNOP file with no options set
Example: Same as above, but with option --param set
Example: Same as the --param example above, but also with option --csv set
Example: Same as the --param example above, but also with option --filter set
Example: Same as the --param example above, but also with option --sort set, for sorting on station identification
Example: Same as the --param example above, but also with option --sort_on TA- set, for sorting on descending temperatures
Example: Dumping another BUFR SYNOP file with some selected parameters only
Example: Same as above, but this time using --transform to display wind speed in knots and cloud cover in %
Example: Dumping yet another BUFR SYNOP file with filter conditions (e.g. stations) and parameters selected on command line
Example: Dumping a BUFR TEMP message with no options set
Example: Dumping a BUFR AMDAR file with no options set
Example: Dumping a BUFR BUOY file (IOB bulletins) with option --
Example: Same as above, but this time with option --
bufrresolve.pl does provide several ways of extracting information from BUFR tables, but you might have special needs not covered by the program. Making your own scripts based on Geo::BUFR should not bee too difficult, however. As an illustration, see dump_flag_tables.pl for a script that dumps all the flag tables in a (hard coded) table file. Running this script produced this output.