core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation

This commit is contained in:
Shahram Najm 2022-05-17 13:57:48 +01:00
parent 043cbb1899
commit e0a2c6cee5
3 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
html/group__environment.html
View File

@ -82,12 +82,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<p><b>ECCODES_DEBUG</b> - If set to 1, it will enable debug level logging messages to be displayed by the library.</p> <p><b>ECCODES_DEBUG</b> - If set to 1, it will enable debug level logging messages to be displayed by the library.</p>
<p><b>ECCODES_FAIL_IF_LOG_MESSAGE</b> - If set to 1, it will cause the library to exit when an error or warning is encountered.</p> <p><b>ECCODES_FAIL_IF_LOG_MESSAGE</b> - If set to 1, it will cause the library to exit when an error or warning is encountered.</p>
<p><b>ECCODES_IO_BUFFER_SIZE</b> - Defines the size in bytes of the buffer used in the IO calls from Fortran and in the tools.</p> <p><b>ECCODES_IO_BUFFER_SIZE</b> - Defines the size in bytes of the buffer used in the IO calls from Fortran and in the tools.</p>
<p><b>ECCODES_NO_ABORT</b> - When set to 1 it causes <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a> not to abort execution on failing asserts.</p> <p><b>ECCODES_NO_ABORT</b> - When set to 1 it causes ecCodes not to abort execution on failing asserts.</p>
<p><b>ECCODES_GRIB_WRITE_ON_FAIL</b> - When set to 1 it will write the last processed GRIB message in a file named $PID_$FILEID_error.grib on failure in a fortran function used without the return code argument.</p> <p><b>ECCODES_GRIB_WRITE_ON_FAIL</b> - When set to 1 it will write the last processed GRIB message in a file named $PID_$FILEID_error.grib on failure in a fortran function used without the return code argument.</p>
<p><b>ECCODES_DEFINITION_PATH</b> - Set to the folder containing the set of definition files you want <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a> to use instead of the default one.</p> <p><b>ECCODES_DEFINITION_PATH</b> - Set to the folder containing the set of definition files you want ecCodes to use instead of the default one.</p>
<p><b>ECCODES_GRIBEX_MODE_ON</b> - When set to 1 it will enable the GRIBEX compatibility mode and <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a> will produce GRIB messages readable by GRIBEX.</p> <p><b>ECCODES_GRIBEX_MODE_ON</b> - When set to 1 it will enable the GRIBEX compatibility mode and ecCodes will produce GRIB messages readable by GRIBEX.</p>
<p><b>ECCODES_GRIB_IEEE_PACKING</b> - Accepted values 32 or 64 for 32 or 64 bits IEEE floating point respectively. The GRIB message produced will contain data written in IEEE floating point without packing.</p> <p><b>ECCODES_SAMPLES_PATH</b> - Set to the folder containing the set of samples you want ecCodes to use instead of the default one. </p>
<p><b>ECCODES_SAMPLES_PATH</b> - Set to the folder containing the set of samples you want <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a> to use instead of the default one. </p>
</div><!-- contents --> </div><!-- contents -->
<!-- start footer part --> <!-- start footer part -->
<hr class="footer"/><address class="footer"><small> <hr class="footer"/><address class="footer"><small>

6
html/index.html
View File

@ -82,9 +82,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Overview</h1> Overview</h1>
<p><b>ecCodes</b> is a package developed by ECMWF which provides an application programming interface and a set of tools for decoding and encoding messages in the following formats:</p> <p><b>ecCodes</b> is a package developed by ECMWF which provides an application programming interface and a set of tools for decoding and encoding messages in the following formats:</p>
<ul> <ul>
<li>WMO FM-92 GRIB edition 1 and edition 2 (<a href="http://www.wmo.int/pages/prog/www/WMOCodes/Guides/GRIB/Introduction_GRIB1-GRIB2.pdf">See WMO document</a>)</li> <li>WMO FM-92 GRIB edition 1 and edition 2</li>
<li>WMO FM-94 BUFR edition 3 and edition 4 (<a href="http://www.wmo.int/pages/prog/www/WMOCodes/Guides/BUFRCREX/Layer1-2-English.pdf">See WMO document</a>)</li> <li>WMO FM-94 BUFR edition 3 and edition 4</li>
<li>WMO GTS <a href="http://www.wmo.int/pages/prog/www/WIS/Publications/WMO_386/WMO_386_Vol_I_en.pdf">abbreviated header</a> (only decoding in this release).</li> <li>WMO GTS abbreviated header (only decoding).</li>
</ul> </ul>
<p>A useful set of <a href="https://confluence.ecmwf.int/display/ECC/Command+line+tools">command line tools</a> provide quick access to the messages. C, Fortran 90 and Python interfaces provide access to the main ecCodes functionality.</p> <p>A useful set of <a href="https://confluence.ecmwf.int/display/ECC/Command+line+tools">command line tools</a> provide quick access to the messages. C, Fortran 90 and Python interfaces provide access to the main ecCodes functionality.</p>
<p>ecCodes is an evolution of GRIB-API. It is designed to provide the user with a simple set of functions to access data from several formats with a key/value approach.</p> <p>ecCodes is an evolution of GRIB-API. It is designed to provide the user with a simple set of functions to access data from several formats with a key/value approach.</p>

12
html/namespaceec_codes.html
View File

@ -365,16 +365,16 @@ Functions</h2></td></tr>
</table> </table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This package is the <b>Python</b> interface to <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a>. </p> <div class="textblock"><p>This package is the <b>Python</b> interface to <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a>. </p>
<p>It offers almost one to one bindings to the C API functions.</p> <p>It offers almost one-to-one bindings to the C API functions.</p>
<p>The Python interface to <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a> uses the <a href="http://numpy.scipy.org/"><b>NumPy</b></a> package as the container of choice for the possible arrays of values that can be encoded/decoded in and from a grib message. Numpy is a package used for scientific computing in Python and an efficient container for generic data.</p> <p>The Python interface to <a class="el" href="namespaceec_codes.html" title="This package is the Python interface to ecCodes. ">ecCodes</a> uses the <a href="http://numpy.scipy.org/"><b>NumPy</b></a> package as the container of choice for the possible arrays of values that can be encoded/decoded in and from a message. Numpy is a package used for scientific computing in Python and an efficient container for generic data.</p>
<p>The Python interface can be enabled/disabled from CMake by using the following flag:<br/> <p>The Python interface can be added via:<br/>
</p> </p>
<div class="fragment"><div class="line"> -DENABLE_PYTHON=ON</div> <div class="fragment"><div class="line"> pip3 install eccodes</div>
<div class="line">or</div> <div class="line">or</div>
<div class="line"> -DENABLE_PYTHON=OFF</div> <div class="line"> pip3 install --install-option="--prefix=/path/to/where/you/install/eccodes" eccodes</div>
</div><!-- fragment --><p>When this is enabed, then the system Python will be used to build the interface.</p> </div><!-- fragment --><p>When this is enabed, then the system Python will be used to build the interface.</p>
<p><em>Requirements:</em> </p> <p><em>Requirements:</em> </p>
<pre class="fragment">- Python 2.6 or higher <pre class="fragment">- Python 3.5 or higher
- NumPy</pre> </div><h2 class="groupheader">Function Documentation</h2> - NumPy</pre> </div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="af4a4c95465d2026ad549920b07150bab"></a> <a class="anchor" id="af4a4c95465d2026ad549920b07150bab"></a>
<div class="memitem"> <div class="memitem">