Skip to main content

Python interface to the ecCodes GRIB and BUFR decoder/encoder

Project description

https://img.shields.io/pypi/v/eccodes.svg

Python 3 interface to decode and encode GRIB and BUFR files via the ECMWF 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 most Linux distributions and MacOS, the ecCodes C-library is the only system dependency,

  • PyPI package can be installed without compiling, at the cost of being twice as slow as the original ecCodes module,

  • an optional compile step makes the code as fast as the original module but it needs the recommended (the most up-to-date) version of ecCodes.

Limitations:

  • Microsoft Windows support is untested.

Installation

From version 2.37.0, the ecCodes Python bindings additionally provide the ecCodes binary library, and will follow the version numbering of the ecCodes binary library. See below for details.

The package is installed from PyPI with:

$ pip install eccodes

This installation will, by default, include the ecCodes binary library (as of version 2.37.0), meaning that no external ecCodes binary library is required. If you have an external ecCodes binary library that you wish to use, set the following environment variable before you import eccodes:

$ export ECCODES_PYTHON_USE_FINDLIBS=1

If this is set, the ecCodes’ Python bindings will use the findlibs package to locate the binary library (findlibs was the only mechanism used before version 2.37.0).

In order to gain insights into the search for the binary library, set the following environment variable before importing eccodes:

$ export ECCODES_PYTHON_TRACE_LIB_SEARCH=1

You may also install a version of ecCodes’ Python interface that does not include a binary library at all, in which case the findlibs mechanism will be used as before:

$ pip install eccodes --no-binary eccodes

System dependencies

The Python module depends on the ECMWF ecCodes library. From version 2.37.0, this is supplied with the Python module. If you wish to install and use a separate binary library (see above), it must be installed on the system and accessible as a shared library.

On a MacOS with HomeBrew use:

$ brew install eccodes

Or if you manage binary packages with Conda use:

$ conda install -c conda-forge eccodes

As an alternative you may install the official source distribution by following the instructions at https://confluence.ecmwf.int/display/ECC/ecCodes+installation

You may run a simple selfcheck command to ensure that your system is set up correctly:

$ python -m eccodes selfcheck
Found: ecCodes v2.37.0.
Your system is ready.

Usage

Refer to the ecCodes documentation pages for usage.

Experimental features

Fast bindings

To test the much faster CFFI API level, out-of-line mode you need the ecCodes header files. Then you need to clone the repo in the same folder as your ecCodes source tree, make a pip development install and custom compile the binary bindings:

$ git clone https://github.com/ecmwf/eccodes-python
$ cd eccodes-python
$ pip install -e .
$ python builder.py

To revert back to ABI level, in-line mode just remove the compiled bindings:

$ rm gribapi/_bindings.*

Project resources

Development

https://github.com/ecmwf/eccodes-python

Download

https://pypi-hypernode.com/project/eccodes

Contributing

The main repository is hosted on GitHub, testing, bug reports and contributions are highly welcomed and appreciated:

https://github.com/ecmwf/eccodes-python

Please see the CONTRIBUTING.rst document for the best way to help.

Maintainer:

Contributors:

See also the list of contributors who 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 at http://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-python

2.37.0 (2024-09-09)

  • bundle ecCodes binary library with the PyPi distribution, for Linux and MacOS

1.7.1 (2024-06-19)

  • np.Infinity was removed in the NumPy 2.0 release

1.7.0 (2024-02-26)

  • ECC-1761: Add function to extract message offsets and sizes

  • ECC-1742: Add function to clone only the meta-data of a message

1.6.1 (2023-10-02)

  • ECC-1693: Update minimum recommended version

  • Fix flake8 warning E721

1.6.0 (2023-07-11)

  • ECC-1630: Get API version as an integer

  • ECC-1622: Drop Python version 3.7

  • ECC-1601: GRIB: Support data values array decoded in single-precision

  • ECC-1611: Add function to determine if a BUFR key is a coordinate descriptor

1.5.2 (2023-04-04)

  • Add support for Python versions 3.10 and 3.11

  • ECC-1555: 2D numpy array incorrectly handled

  • ECC-1539: Use the ‘warnings’ library for selfcheck

  • ECC-1538: Add support for CODES_TYPE_BYTES

  • ECC-1524: Check values in High-level Message.set function should retrieve based on value type

  • ECC-1527: Handle floats in high-level Message.set function check values

1.5.1 (2023-01-25)

  • ECC-1446: Data file era5-levels-members.grib not included in released tar file

  • ECC-1460: Cannot import eccodes on M1 MacBook Pro

  • ECC-1505: High-level Message.set function should allow dictionary and check result

1.5.0 (2022-08-25)

  • ECC-1404: Add the grib_get_gaussian_latitudes() function

  • ECC-1405: Add new function: codes_any_new_from_samples

  • ECC-1415: Implement a higher-level Python interface (still experimental)

  • ECC-1429: Remove the file ‘eccodes/messages.py’

  • GitHub pull request #62: add pypi badge

1.4.2 (2022-05-20)

  • ECC-1389: Drop Python version 3.5 and 3.6

  • ECC-1390: NameError: name ‘GribInternalError’ is not defined

  • Add test for GRIB bitmap

1.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 file

1.4.0 (2021-12-03)

  • ECC-1234: Remove the experimental high-level interface

  • ECC-1282: Add codes_dump()

1.3.4 (2021-08-27)

  • Update documentation

1.3.3 (2021-06-21)

  • ECC-1246: UnicodeDecodeError when parsing BUFR file

1.3.2 (2021-04-16)

  • Restore the experimental high-level interface

1.3.1 (2021-04-16)

  • Fix the recommended version

1.3.0 (2021-04-09)

  • ECC-1231: Remove the experimental high-level interface

  • Added the “findlibs” module

  • Fix tests/test_high_level_api.py when MEMFS enabled

  • ECC-1226: Python3 bindings: Typo causes AttributeError when calling codes_index_get_double

1.2.0 (2021-03-23)

  • Added test for multi-field GRIBs

  • Fix deprecation warning: np.float is a deprecated alias for the builtin float

  • Experimental feature: grib_nearest_find

1.1.0 (2021-01-20)

  • ECC-1171: Performance: Python bindings: remove assert statements

  • ECC-1161: Python3 bindings: Do not raise exception on first failed attempt

  • ECC-1176: Python3 bindings: float32 recognised as int instead of float

  • GitHub pull request #41: Remove the apparent support for Python 2

  • GitHub pull request #44: Fix CFFI crash on windows

  • GitHub 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.4

  • ECC-1133: C API: Propagate const char* for codes_index_new_from_file and codes_index_select_string

0.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 exceptions

  • Fix codes_set_definitions_path() typo

  • Fix grib_get_double_element(). Missing last argument

  • Add more tests to increase coverage

  • GitHub pull request #15: Add .__next__() method to eccodes.CodesFile class

  • ECC-1113: Python3 bindings under Windows: codes_get_long_array returns incorrect values

  • ECC-1108: Python3 bindings under Windows: use of handle causes crash

  • ECC-1121: Segfault when closing GribFile if messages are closed manually

0.9.6 (2020-03-10)

  • Update Copyright notices

  • Function-argument type checks: Improve error message

  • Fix C function calls for codes_gribex_mode_on/codes_gribex_mode_off

0.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=1

  • ECC-1032: Added codes_samples_path() and codes_definition_path()

  • ECC-1042: Python3 interface writes integer arrays incorrectly

  • ECC-794: Python3 interface: Expose the grib_get_data function

0.9.4 (2019-11-27)

  • Added new function: codes_get_version_info

  • ECC-753: Expose the codes_grib_nearest_find_multiple function in Python

  • ECC-1007: Python3 interface for eccodes cannot write large arrays

0.9.3 (2019-10-04)

  • New exception added: FunctionalityNotEnabledError

  • BUFR decoding: support for multi-element constant arrays (ECC-428)

0.9.2 (2019-07-09)

  • All ecCodes tests now pass

  • Simplify the xx_new_from_file calls

  • Fix for grib_set_string_array

  • Use ECCODES_DIR to locate the library

  • Remove the new-style high-level interface. It is still available in cfgrib.

0.9.1 (2019-06-06)

  • codes_get_long_array and codes_get_double_array now return a np.ndarray. See: #3.

0.9.0 (2019-05-07)

  • Declare the project as Beta.

0.8.0 (2019-04-08)

  • First public release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eccodes-2.37.0.tar.gz (2.3 MB view details)

Uploaded Source

Built Distributions

eccodes-2.37.0-py3-none-any.whl (42.6 kB view details)

Uploaded Python 3

eccodes-2.37.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

eccodes-2.37.0-cp312-cp312-macosx_13_0_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.12 macOS 13.0+ x86-64

eccodes-2.37.0-cp312-cp312-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.12 macOS 13.0+ ARM64

eccodes-2.37.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

eccodes-2.37.0-cp311-cp311-macosx_13_0_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.11 macOS 13.0+ x86-64

eccodes-2.37.0-cp311-cp311-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.11 macOS 13.0+ ARM64

eccodes-2.37.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

eccodes-2.37.0-cp310-cp310-macosx_13_0_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.10 macOS 13.0+ x86-64

eccodes-2.37.0-cp310-cp310-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.10 macOS 13.0+ ARM64

eccodes-2.37.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

eccodes-2.37.0-cp39-cp39-macosx_13_0_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.9 macOS 13.0+ x86-64

eccodes-2.37.0-cp39-cp39-macosx_13_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.9 macOS 13.0+ ARM64

eccodes-2.37.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

File details

Details for the file eccodes-2.37.0.tar.gz.

File metadata

  • Download URL: eccodes-2.37.0.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for eccodes-2.37.0.tar.gz
Algorithm Hash digest
SHA256 ce9e11dba82dbdfee8803a26d03fe200307b23eac08e20c029c3e84b84757305
MD5 0d2d1d432464bacda10d6aca3620eb3d
BLAKE2b-256 409a4b81cdb6cf670006511af66d11b654da2af132cd24797a2fd34338c3c77e

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-py3-none-any.whl.

File metadata

  • Download URL: eccodes-2.37.0-py3-none-any.whl
  • Upload date:
  • Size: 42.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for eccodes-2.37.0-py3-none-any.whl
Algorithm Hash digest
SHA256 434e9e832d965f23141effa28a6997c635243d4d7cb8afb7ff453c6627014fc1
MD5 7567660832b0866600677132c5f22df2
BLAKE2b-256 7d664c544641cdb78a1eb191f722fc2de8c919ecb4ca004888706fc110cc800f

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 76d3a7dbaf5590ade2f5c45ba6d2567a7b01864a407f8be4a06bdfc9a5e2e30b
MD5 0ba942244ad9ceec5c0fa6fd3f7983c7
BLAKE2b-256 8f4583c55afaf38fad077470d3cacb2364b6131e3217e74f074b8b89fd74e181

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp312-cp312-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp312-cp312-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 1fbfad23f5f31e5f578f6a9bb46b8b5fdf6e09d033e42a600cc2212278bb7c07
MD5 a8f11f7312658c827fb54ce6cbf14a0f
BLAKE2b-256 8df6c520942f15f130729a67dcc80de3ade644ef4fa18a681b16cabfb47336d6

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp312-cp312-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp312-cp312-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 4a107567b55fa0188b7215ea0e5d78680dcd73b6b80596d38c15587fae141713
MD5 a1c4a725ec5bd0dd32d83bbc7a37925a
BLAKE2b-256 13ce8a7dbf2cbc3cfc2c7aba3c55dc0f9faee3d7d2999e52a2a6eb7093f9a638

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3b963e5f9a945fa8bca18b66bdfa32cee513a6b080effd967daf4e10ba3f741f
MD5 26a553e9bce91c4188e30e84cfbbfa69
BLAKE2b-256 461c8c28c5d56e7038206ccac2508935266f203044b8d6a8cd370e631b61bc2b

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp311-cp311-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp311-cp311-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 ccd454d7ceecde90a092d104af9065ad7503a339b46b37719f09d9420845ee6f
MD5 a1e2ee7a444523ac4cf33ebd0e816372
BLAKE2b-256 13a2606c04e372824e5513f240491e2d664937a8d6e2382ad586b0a12ef89e90

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp311-cp311-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp311-cp311-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 28b6b059e5bc156e3b6814f93b291aba9c290502652fabf638972656e6ccae25
MD5 3d6af51883c792646d85015f581b8ef6
BLAKE2b-256 e10b968fcaf56610711b8fb60d9d85fcdbcb8dfc2b6360f0587ce6e4d18a582f

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4c4f980ac4664fb8324d5195dbba833c3b45513c4451791038721af1784f46f3
MD5 c1b9ee0f99bae11a5acc06dabf731f3f
BLAKE2b-256 0d4bd90f30de329475d62ae260371a4dafa2ffc30a18164ed5bd43c8421318c6

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp310-cp310-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp310-cp310-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 a213138088e93cf2c17c20aafa0890d7c99d042c494836553d6b4416fd4a5235
MD5 fb3309b0e9e3e34791c525d82c8bd194
BLAKE2b-256 41bccf894ee62009c8d8d3fdf8bdac3d2ad1ca0ed91e31537cac4919e4d70b3e

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp310-cp310-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp310-cp310-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 5cdb8c8e113db2e284a43391603a6e1a1ae69b7cd4063258b2e8a23538d91f90
MD5 44c55c31b82b1f6070876e0f6beca4ce
BLAKE2b-256 fe59b6e83a0e5c26044993ff88a79010637ce431716e20be0769aa573f96a0e7

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1c0b5cec6dac9d2985345e79a6d29ae7e27d0a8e5b9fcd0c571081aa0f1c76f0
MD5 45a782661cc19b0c6579f561b5fec9ff
BLAKE2b-256 fbe1b91947184f43f40c4e9742726cdb4fc5afc37137f30b2daa96f51a32abb3

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp39-cp39-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp39-cp39-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 964e57ac46f9b01d3ab54acdb4cfae44bbb4c24ee9d5d76eed43892c8e5dabdf
MD5 f865cd29f15731b0051963d6a3552178
BLAKE2b-256 e3efc1ec99403aceabbfa45265d8275a178461fdf6718d5bc4d88bd4bda05975

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp39-cp39-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp39-cp39-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 f43c3f90be33a2362400a589d3d086eba37f118109c2d431c735b25c5c769d88
MD5 ec51c4a9b30b06dafb8a6e18b05bedda
BLAKE2b-256 b746dc85d76466b59ee6b405f2883d37636324bdcf95cdf327c4dc218343d84f

See more details on using hashes here.

File details

Details for the file eccodes-2.37.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for eccodes-2.37.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 12d1738c607289ab42be90e9246b1e6efd4f5aefd0cb2eaf341e8aebd70d01fe
MD5 682d6efddf7725ea07f36af934162327
BLAKE2b-256 e9d1f9cd8166c06dd712aaba86b6f5319156e8cc6b5d7d01d4214c5f2c9e238f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page