Skip to main content

Python interface to the ecCodes GRIB and BUFR decoder/encoder

Project description

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 3.7, 3.6, 3.5 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

The package is installed from PyPI with:

$ pip install eccodes

System dependencies

The Python module depends on the ECMWF ecCodes library that 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://software.ecmwf.int/wiki/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.20.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 more just remove the compiled bindings:

$ rm gribapi/_bindings.*

Project resources

Development https://github.com/ecmwf/eccodes-python
Download https://pypi.org/project/eccodes
Code quality Build Status on Travis CI Coverage Status on Coveralls

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

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

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.

Files for eccodes, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size eccodes-1.1.0-py3-none-any.whl (46.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size eccodes-1.1.0.tar.gz (60.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page