Documentation

This commit is contained in:
Shahram Najm 2018-12-28 12:00:18 +00:00
parent 0ec1a0bf80
commit 76be63d054
4 changed files with 11 additions and 11 deletions

View File

@ -15,7 +15,7 @@
#define ECCODES_VERSION_STR "@ECCODES_VERSION_STR@" #define ECCODES_VERSION_STR "@ECCODES_VERSION_STR@"
/* ECCODES_VERSION is defined in grib_api.h from the 3 version components below */ /* ECCODES_VERSION is defined in eccodes_version.h from the 3 version components below */
#define ECCODES_MAJOR_VERSION @ECCODES_MAJOR_VERSION@ #define ECCODES_MAJOR_VERSION @ECCODES_MAJOR_VERSION@
#define ECCODES_MINOR_VERSION @ECCODES_MINOR_VERSION@ #define ECCODES_MINOR_VERSION @ECCODES_MINOR_VERSION@

View File

@ -85,7 +85,7 @@ int main( int argc,char* argv[])
"It is recommended you use ECCODES_DEFINITION_PATH instead!)\n"); "It is recommended you use ECCODES_DEFINITION_PATH instead!)\n");
} else { } else {
printf("Default definition files path is used: %s\n",ECCODES_DEFINITION_PATH); printf("Default definition files path is used: %s\n",ECCODES_DEFINITION_PATH);
printf("Definition files path can be changed setting ECCODES_DEFINITION_PATH environment variable\n"); printf("Definition files path can be changed by setting ECCODES_DEFINITION_PATH environment variable\n");
} }
printf("\n"); printf("\n");
@ -99,7 +99,7 @@ int main( int argc,char* argv[])
"It is recommended you use ECCODES_SAMPLES_PATH instead!)\n"); "It is recommended you use ECCODES_SAMPLES_PATH instead!)\n");
} else { } else {
printf("Default SAMPLES path is used: %s\n",ECCODES_SAMPLES_PATH); printf("Default SAMPLES path is used: %s\n",ECCODES_SAMPLES_PATH);
printf("SAMPLES path can be changed setting ECCODES_SAMPLES_PATH environment variable\n"); printf("SAMPLES path can be changed by setting ECCODES_SAMPLES_PATH environment variable\n");
} }
printf("\n"); printf("\n");
return 0; return 0;

View File

@ -1,6 +1,6 @@
/*! \page grib_dump grib_dump /*! \page grib_dump grib_dump
\section DESCRIPTION \section DESCRIPTION
Dump the content of a grib file in different formats. Dump the content of a GRIB file in different formats.
\section USAGE \section USAGE
grib_dump grib_dump
@ -42,7 +42,7 @@
\verbatim \verbatim
>grib_dump -OtaH ../data/reduced_gaussian_model_level.grib1 >grib_dump -OtaH ../data/reduced_gaussian_model_level.grib1
\endverbatim\n \endverbatim\n
-# To obtain all the key names (computed keys included) available in a grib file.\n -# To obtain all the key names (computed keys included) available in a GRIB file.\n
\verbatim \verbatim
> grib_dump -D ../data/regular_latlon_surface.grib1 > grib_dump -D ../data/regular_latlon_surface.grib1
\endverbatim\n \endverbatim\n

View File

@ -26,17 +26,17 @@
As -p adding the declared keys to the default list. As -p adding the declared keys to the default list.
\n \n -w key[:{s/d/i}]{=/!=}value,key[:{s/d/i}]=value,... \n \n \n -w key[:{s/d/i}]{=/!=}value,key[:{s/d/i}]=value,... \n
Where clause. Where clause.
Set is only executed for grib messages matching all the key/value constraints. Set is only executed for GRIB messages matching all the key/value constraints.
If a grib message does not match the constraints it is copied unchanged If a GRIB message does not match the constraints it is copied unchanged
to the output_grib_file. This behaviour can be changed setting the option -S. to the output_grib_file. This behaviour can be changed by setting the -S option.
A valid constraint is of type key=value or key!=value. A valid constraint is of type key=value or key!=value.
For each key a string (key:s), a double (key:d) or an integer (key:i) For each key a string (key:s), a double (key:d) or an integer (key:i)
type can be defined. Default type is string. type can be defined. Default type is string.
\n \n -7 \n Does not fail when the message has wrong length \n \n -7 \n Does not fail when the message has wrong length
\n \n -S \n Strict. Only grib messages matching all the constraints are copied to \n \n -S \n Strict. Only GRIB messages matching all the constraints are copied to
the output file the output file
\n \n -V \n Version. \n \n -V \n Version.
\n \n -M \n Multi-field support off. Turn off support for multiple fields in single grib message. \n \n -M \n Multi-field support off. Turn off support for multiple fields in single GRIB message.
\n \n -g \n Copy GTS header. \n \n -g \n Copy GTS header.
\n \n -G \n GRIBEX compatibility mode. \n \n -G \n GRIBEX compatibility mode.
\n \n -T T | B | M | A \n Message type. T->GTS, B->BUFR, M->METAR (Experimental),A->Any (Experimental). \n \n -T T | B | M | A \n Message type. T->GTS, B->BUFR, M->METAR (Experimental),A->Any (Experimental).
@ -64,7 +64,7 @@ Since some values can not be set to missing you can get an error for those keys.
\verbatim \verbatim
>grib_set -s scaleFactorOfSecondFixedSurface=missing -w scaleFactorOfSecondFixedSurface!=missing tigge_pf_ecmwf.grib2 out.grib2 >grib_set -s scaleFactorOfSecondFixedSurface=missing -w scaleFactorOfSecondFixedSurface!=missing tigge_pf_ecmwf.grib2 out.grib2
\endverbatim\n \endverbatim\n
-# It's possible to produce a grib edition 2 file from a grib edition 1 just changing the edition number with grib_set. -# It's possible to produce a GRIB edition 2 file from a GRIB edition 1 just changing the edition number with grib_set.
At this stage of development all the geography parameters, level and time information is correctly translated, for the product At this stage of development all the geography parameters, level and time information is correctly translated, for the product
definition extra 'set' calls must be done. To do this properly, use the tool grib_filter.\n definition extra 'set' calls must be done. To do this properly, use the tool grib_filter.\n
\verbatim \verbatim