grib-rs

GRIB format parser for Rust

About

This is a GRIB format parser library written in Rust programming language. This project aims to provide a set of library and tools which is simple-to-use, efficient, and educational.

GRIB is a concise data format commonly used in meteorology to store historical and forecast weather data. It is intended to be a container of a collection of records of 2D data. GRIB files are huge and binary and should be processed efficiently. Also, since GRIB is designed to support various grid types and data compression using parameters defined in external code tables and templates, some popular existing softwares cannot handle some GRIB data.

Vision

A world where everyone can read weather data easily although its interpretation needs some specific knowledge and experience.

Features

• Rust library grib
  • Ability to read and check the basic structure of GRIB2
  • Ability to access data inside the GRIB2 message:
    • List of surfaces
    • Some parameters of each surface, which are important for most users
    • Underlying sections which make up surfaces and the entire data
  • Support for some code tables defined by WMO
  • Decoding feature supporting following templates:
    • Template 5.0/7.0 (simple packing)
    • Template 5.3/7.3 (complex packing)
    • Template 5.40/7.40 (JPEG 2000 code stream format)
    • Template 5.200/7.200 (run-length encoding)
• CLI application gribber built on the top of the Rust library
  • 4 subcommends:
    • decode: data export as text and flat binary files
    • info: display of identification information
    • inspect: display of information mainly for development purpose such as template numbers
    • list: display of parameters for each surface inside

Planned features

Please check the ROADMAP to see planned features.

API

API Documentation of the released version of the library crate is available on Docs.rs although it is not extensive. The development version is available on GitHub Pages.

The examples may help you understand the API. The functionality is still inadequate, and we are working on expanding the basic functionality as our top priority in this project, so we would be happy to receive any requests.

CLI application gribber

USAGE:
    gribber [SUBCOMMAND]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    decode     Export decoded data
    help       Print this message or the help of the given subcommand(s)
    info       Show identification information
    inspect    Inspect and describes the data structure
    list       List surfaces contained in the data

Note that binaries exported from gribber decode --big-endian use 0x7fc00000 as a missing value, although those from wgrib use 0x6258d19a.

Building

This repository uses the submodules functionality of Git. So, before running cargo build, please add submodules in one of following ways:

• Cloning with submodules: adding --recursive to git clone will automatically clone submodules in addition to this repository
• Adding submodules after cloning: running git submodule update --init --recursive after cloning will update the repository to have submodules

Then you can build it in the usual way in the Rust world.

cargo build

Contributing

Contribution is always welcome. Please check CONTRIBUTING.md if you are interested.

License

This project is licensed under either of

• Apache License, Version 2.0 (See LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0), and
• MIT license (See LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

SPDX-License-Identifier: Apache-2.0 OR MIT