Skip to main content

Python 3 interface to encode and decode 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 a recent version of ecCodes >= 2.15.0.

Limitations:

  • Microsoft Windows support is untested.

Installation

The package is installed from PyPI with:

$ pip install eccodes-python

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.15.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-python

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

Copyright 2017-2019 European Centre for Medium-Range Weather Forecasts (ECMWF).

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Changelog for eccodes-python

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.

Metadata

Release files for eccodes-python 0.9.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eccodes-python 0.9.4
File Size Uploaded Provenance
eccodes-python-0.9.4.tar.gz 50.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for eccodes-python 0.9.4
File Interpreter ABI Platform
eccodes_python-0.9.4-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 93.9 kB

Release files / eccodes-python-0.9.4.tar.gz

Download URL eccodes-python-0.9.4.tar.gz
Size 50.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ff57a0d3d9bac060823466d02b496ebe10a62e3dabd8f629e20849500513aaf7
BLAKE2b-256 checksum
How to use checksums
a70b401ee2970fd8c76cfc9913112eefc857db72314ac49be60915d5a79142d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

Release files / eccodes_python-0.9.4-py2.py3-none-any.whl

Download URL eccodes_python-0.9.4-py2.py3-none-any.whl
Size 43.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b2f05a7f56644c10990a619c915917c4cfba56977aaf2a7d58085e4ee8667979
BLAKE2b-256 checksum
How to use checksums
ad4d39c1136c031ece65e1486d344a21889f2aa2b64b27456aac7bdd97ab381b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

Security for eccodes-python 0.9.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page