Herbie: Retrieve NWP Model Data#

Herbie is a python package that downloads recent and archived numerical weather prediction (NWP) model output from different cloud archive sources. NWP data is distributed in GRIB2 format and can be read with xarray+cfgrib.

Some models Herbie can retrieve data from include:

  • High-Resolution Rapid Refresh (HRRR)

  • Rapid Refresh (RAP)

  • Global Forecast System (GFS)

  • ECMWF open data forecast products (ECMWF (IFS and AIFS))

  • National Blend of Models (NBM)

  • Rapid Refresh Forecast System - Prototype (RRFS)

  • Real-Time/Un-Restricted Mesoscale Analysis (RTMA and URMA)

  • and many others (see Gallery)

Installation#

mamba install -c conda-forge herbie-data

conda install -c conda-forge herbie-data

pip install herbie-data

Add Herbie to your uv project with the following command:

uv add herbie-data

Or install Herbie as a tool for its CLI

uv install herbie-data

More details at šŸ Installation.

Capabilities#

Herbie helps you discover and use data from many different numerical weather models and sources.

_images/mermaid-capabilities.png

Specifically, Herbie can do the following:

  • Locate GRIB2 files in the cloud.

  • Show the content of those files.

  • Download data to your computer.

  • Download subsets of the data.

  • Read the data with xarray.

  • Help you use the data with xarray accessors (see šŸ—ƒļø Xarray Accessors)

Herbie Python#

Using Herbieā€™s Python API looks something like thisā€¦

from herbie import Herbie

# Create Herbie object for the HRRR model 6-hr surface forecast product
H = Herbie(
  '2021-01-01 12:00',
  model='hrrr',
  product='sfc',
  fxx=6
)

# Look at the GRIB2 file contents
H.inventory()

# Download the full GRIB2 file
H.download()

# Download a subset of the file, like all fields at 500 mb
H.download(":500 mb")

# Read a subset of the file with xarray, like 2-m temperature.
H.xarray("TMP:2 m")

Herbie CLI#

Herbie also has a command line interface (CLI) so you can use Herbie right in your terminal.

# Get the URL for a HRRR surface file from today at 12Z
herbie data -m hrrr --product sfc -d "2023-03-15 12:00" -f 0

# Download GFS 0.25Ā° forecast hour 24 temperature at 850mb
herbie download -m gfs --product 0p25 -d 2023-03-15T00:00 -f 24 --subset ":TMP:850 mb:"

# View all available variables in a RAP model run
herbie inventory -m rap -d 2023031512 -f 0

# Download multiple forecast hours for a date range
herbie download -m hrrr -d 2023-03-15T00:00 2023-03-15T06:00 -f 1 3 6 --subset ":UGRD:10 m:"

# Specify custom source priority (check only Google)
herbie data -m hrrr -d 2023-03-15 -f 0 -p google

More details in the User Guide.