A light-weight pure Python GRIB reader
Fons 6a16260c18 Merge branch 'develop' | 5 years ago | |
---|---|---|
pupygrib | 5 years ago | |
tests | 7 years ago | |
.gitignore | 5 years ago | |
CHANGES.md | 5 years ago | |
LICENSE.txt | 7 years ago | |
MANIFEST.in | 5 years ago | |
README.md | 5 years ago | |
setup.cfg | 7 years ago | |
setup.py | 5 years ago | |
tox.ini | 7 years ago |
Pupygrib (pronounced puppy grib and short for PUre PYthon GRIB) is a light-weight pure Python GRIB reader. It's purpose is to extract data from GRIB files with as little effort as possible. The user can then freely choose how to further process the data (read: pupygrib will not help you).
This project is in the alpha phase, which means that many planned features are missing and implemented features are not well tested. It also means that the API may change in future version. The implemented features are:
The planned features are:
$ pip install pupygrib
For development, the following command will install all extra requirements, including test requirements:
$ pip install pupygrib[dev]
To use pupygrib, you will need a good understanding of the GRIB format, especially since table lookups are not yet implemented. ECMWF provides an overview of GRIB edition 1 and edition 2 that can be used as references.
Iterate over the messages in a GRIB file and extract the coordinates and values:
>>> import pupygrib
>>> with open('tests/data/regular_latlon_surface.grib1', 'rb') as stream:
... for i, msg in enumerate(pupygrib.read(stream), 1):
... lons, lats = msg.get_coordinates()
... values = msg.get_values()
... print("Message {}: {:.3f} {}".format(i, values.mean(), lons.shape))
...
Message 1: 291.585 (31, 16)
Access a section of a GRIB message and print its fields:
>>> with open('tests/data/regular_latlon_surface.grib1', 'rb') as stream:
... msg, = pupygrib.read(stream)
>>> sorted(msg[0].fieldnames) # fieldnames is a set, so we can't trust the order
['editionNumber', 'identifier', 'totalLength']
>>> msg[0].totalLength
1100
>>> msg[3] is None # the bit-map section is not included in this message
True
Pull requests are most welcome! I do ask that you add test cases and update the documentation for any new features. Make sure that the following checks (coding style, unit tests, and the manifest, respectively) pass without any warnings or errors. Tox should have at least one supported Python 2 and Python 3 version available.
$ flake8
$ tox
$ check-manifest
Pupygrib is being developed by Mattias Jakobsson at SMHI. It is released under the GNU General Public License v3 or later (GPLv3+).