Package: eccodes
Python 3 interface to decode and encode GRIB and BUFR files via theECMWF ecCodes library.Features:reads and writes GRIB 1 and 2 files,reads and writes BUFR 3 and 4 files,supports all modern versions of Python and PyPy3,works on mostLinuxdistributions andMacOS, theecCodesC-library
is the only system dependency,PyPI package can be installed without compiling,
at the cost of being twice as slow as the originalecCodesmodule,an optional compile step makes the code as fast as the original module
but it needs the recommended (the most up-to-date) version ofecCodes.Limitations:Microsoft Windows support is untested.InstallationThe package is installed from PyPI with:$ pip install eccodesSystem dependenciesThe Python module depends on the ECMWFecCodeslibrary
that must be installed on the system and accessible as a shared library.On a MacOS with HomeBrew use:$ brew install eccodesOr if you manage binary packages withCondause:$ conda install -c conda-forge eccodesAs an alternative you may install the official source distribution
by following the instructions athttps://confluence.ecmwf.int/display/ECC/ecCodes+installationYou may run a simple selfcheck command to ensure that your system is set up correctly:$ python -m eccodes selfcheck
Found: ecCodes v2.27.0.
Your system is ready.UsageRefer to theecCodesdocumentation pagesfor usage.Experimental featuresFast bindingsTo test the much fasterCFFIAPI level, out-of-line mode you need theecCodesheader files.
Then you need to clone the repo in the same folder as yourecCodessource tree, make apipdevelopment install and custom compile
the binary bindings:$ git clone https://github.com/ecmwf/eccodes-python
$ cd eccodes-python
$ pip install -e .
$ python builder.pyTo revert back to ABI level, in-line mode just remove the compiled bindings:$ rm gribapi/_bindings.*Project resourcesDevelopmenthttps://github.com/ecmwf/eccodes-pythonDownloadhttps://pypi.org/project/eccodesContributingThe main repository is hosted on GitHub,
testing, bug reports and contributions are highly welcomed and appreciated:https://github.com/ecmwf/eccodes-pythonPlease see the CONTRIBUTING.rst document for the best way to help.Maintainer:Shahram Najm-ECMWFContributors:Alessandro Amici-B-OpenSee also the list ofcontributorswho participated in this project.License© Copyright 2017- ECMWF.This software is licensed under the terms of the Apache Licence Version 2.0
which can be obtained athttp://www.apache.org/licenses/LICENSE-2.0.In applying this licence, ECMWF does not waive the privileges and immunities
granted to it by virtue of its status as an intergovernmental organisation nor
does it submit to any jurisdiction.Changelog for eccodes-python1.7.0 (2024-02-26)ECC-1761: Add function to extract message offsets and sizesECC-1742: Add function to clone only the meta-data of a message1.6.1 (2023-10-02)ECC-1693: Update minimum recommended versionFix flake8 warning E7211.6.0 (2023-07-11)ECC-1630: Get API version as an integerECC-1622: Drop Python version 3.7ECC-1601: GRIB: Support data values array decoded in single-precisionECC-1611: Add function to determine if a BUFR key is a coordinate descriptor1.5.2 (2023-04-04)Add support for Python versions 3.10 and 3.11ECC-1555: 2D numpy array incorrectly handledECC-1539: Use the ‘warnings’ library for selfcheckECC-1538: Add support for CODES_TYPE_BYTESECC-1524: Check values in High-level Message.set function should retrieve based on value typeECC-1527: Handle floats in high-level Message.set function check values1.5.1 (2023-01-25)ECC-1446: Data file era5-levels-members.grib not included in released tar fileECC-1460: Cannot import eccodes on M1 MacBook ProECC-1505: High-level Message.set function should allow dictionary and check result1.5.0 (2022-08-25)ECC-1404: Add the grib_get_gaussian_latitudes() functionECC-1405: Add new function: codes_any_new_from_samplesECC-1415: Implement a higher-level Python interface (still experimental)ECC-1429: Remove the file ‘eccodes/messages.py’GitHub pull request #62: add pypi badge1.4.2 (2022-05-20)ECC-1389: Drop Python version 3.5 and 3.6ECC-1390: NameError: name ‘GribInternalError’ is not definedAdd test for GRIB bitmap1.4.1 (2022-03-03)ECC-1351: Support numpy.int64 in codes_set() and codes_set_long()ECC-1317: Data file tiggelam_cnmc_sfc.grib2 not included in released tar file1.4.0 (2021-12-03)ECC-1234: Remove the experimental high-level interfaceECC-1282: Add codes_dump()1.3.4 (2021-08-27)Update documentation1.3.3 (2021-06-21)ECC-1246: UnicodeDecodeError when parsing BUFR file1.3.2 (2021-04-16)Restore the experimental high-level interface1.3.1 (2021-04-16)Fix the recommended version1.3.0 (2021-04-09)ECC-1231: Remove the experimental high-level interfaceAdded the “findlibs” moduleFix tests/test_high_level_api.py when MEMFS enabledECC-1226: Python3 bindings: Typo causes AttributeError when calling codes_index_get_double1.2.0 (2021-03-23)Added test for multi-field GRIBsFix deprecation warning:np.floatis a deprecated alias for the builtinfloatExperimental feature: grib_nearest_find1.1.0 (2021-01-20)ECC-1171: Performance: Python bindings: remove assert statementsECC-1161: Python3 bindings: Do not raise exception on first failed attemptECC-1176: Python3 bindings: float32 recognised as int instead of floatGitHub pull request #41: Remove the apparent support for Python 2GitHub pull request #44: Fix CFFI crash on windowsGitHub pull request #42: Add unit testing with GitHub actions (linux, macos and windows)1.0.0 (2020-10-14)ECC-1143: CMake: Migration to ecbuild v3.4ECC-1133: C API: Propagate const char* for codes_index_new_from_file and codes_index_select_string0.9.9 (2020-08-04)Support for ecmwflibs. An additional way to find ECMWF libraries (if available)ECC-1140: Segfault from invalid pointer reference in grib_set_double_array()0.9.8 (2020-06-26)ECC-1110: Removed obsolete function codes_close_file()Provide missing argument to exceptionsFix codes_set_definitions_path() typoFix grib_get_double_element(). Missing last argumentAdd more tests to increase coverageGitHub pull request #15: Add .__next__() method to eccodes.CodesFile classECC-1113: Python3 bindings under Windows: codes_get_long_array returns incorrect valuesECC-1108: Python3 bindings under Windows: use of handle causes crashECC-1121: Segfault when closing GribFile if messages are closed manually0.9.6 (2020-03-10)Update Copyright noticesFunction-argument type checks: Improve error messageFix C function calls for codes_gribex_mode_on/codes_gribex_mode_off0.9.5 (2020-01-15)ECC-1029: Function-argument type-checking should be disabled by default.To enable these checks, export ECCODES_PYTHON_ENABLE_TYPE_CHECKS=1ECC-1032: Added codes_samples_path() and codes_definition_path()ECC-1042: Python3 interface writes integer arrays incorrectlyECC-794: Python3 interface: Expose the grib_get_data function0.9.4 (2019-11-27)Added new function: codes_get_version_infoECC-753: Expose the codes_grib_nearest_find_multiple function in PythonECC-1007: Python3 interface for eccodes cannot write large arrays0.9.3 (2019-10-04)New exception added: FunctionalityNotEnabledErrorBUFR decoding: support for multi-element constant arrays (ECC-428)0.9.2 (2019-07-09)All ecCodes tests now passSimplify the xx_new_from_file callsFix for grib_set_string_arrayUse ECCODES_DIR to locate the libraryRemove the new-style high-level interface. It is still available incfgrib.0.9.1 (2019-06-06)codes_get_long_arrayandcodes_get_double_arraynow return anp.ndarray.
See:#3.0.9.0 (2019-05-07)Declare the project asBeta.0.8.0 (2019-04-08)First public release.