Skip to main content

Python 3 interface to encode and decode GRIB and BUFR files via the ECMWF ecCodes library.

Features with development status Beta:

  • 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 with no install time build (binds with CFFI ABI level, in-line mode),

  • supports writing the index of a GRIB file to disk, to save a full-file scan on open.

Limitations:

  • CFFI ABI level, in-line mode is almost twice as slow as the original ecCodes bindings,

  • only experimental support for the much faster CFFI API level, out-of-line mode,

  • PyPI binary packages do not include ecCodes,

  • incomplete documentation, for now,

  • no Windows support, for now.

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. Some Linux distributions ship a binary version that may be installed with the standard package manager. On Ubuntu 18.04 use the command:

$ sudo apt-get install libeccodes0

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.7.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 source tree available, because we need two include files grib_api_internal.h and grib_api_prototypes.h that are not installed by default. Then you need to clone the repo in the same folder as your eccodes sourexe 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 .
$ CPPFLAGS=-I../eccodes/src python builder.py

To revert back to ABI level, in-line more just remove the compiled bindngs:

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

Lead developer:

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

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.0
File Size Uploaded
eccodes-python-0.9.0.tar.gz 2.3 MB Details

Built distribution (wheel)

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

Total release size: 2.3 MB

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

Download URL eccodes-python-0.9.0.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
ff8c46d82ce1340ee673871b5f45118ac5c95083631e0927082b59d1e701cf6b
BLAKE2b-256 checksum
How to use checksums
e0a11261785b6d45fe28c66fd3c657e7d832cd63bf461493016caa14f8163a82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.2 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

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

Download URL eccodes_python-0.9.0-py2.py3-none-any.whl
Size 42.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
5fd137ee482749487ce8fb9f27171d569a0723784e646f34c62b70e719289faf
BLAKE2b-256 checksum
How to use checksums
422bbfaf606cac49fb7e159ed37b4c59ffeda46ca244467d57c0a6e0bc225c1a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.2 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

Release history Release notifications | RSS feed

0.9.9

2 release files

0.9.8

2 release files

0.9.7

2 release files

0.9.5

2 release files

0.9.4

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

This release

0.9.0 This release

2 release files

0.8.0

2 release files

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