Skip to main content

Herbie: Retrieve NWP Model Data

DOI

The NOAA Big Data Program has made weather data more accessible than ever before. Herbie is a python package that downloads recent and archived numerical weather prediction (NWP) model output from different cloud archive sources. Herbie helps you discover and download High Resolution Rapid Refresh (HRRR), Rapid Refresh (RAP), Global Forecast System (GFS), National Blend of Models (NBM), and Rapid Refresh Forecast System - Prototype (RRFS). NWP data is usually in GRIB2 format and can be read with xarray/cfgrib.

📔 Herbie Documentation

Install

Requires cURL and Python 3.8+ with requests, numpy, pandas, xarray, and cfgrib. Optional packages are matplotlib, cartopy, and Carpenter Workshop.

pip install herbie-data

or

pip install git+https://github.com/blaylockbk/Herbie.git

or, create the provided conda environment.

Capabilities

  • Search different data sources for model output.
  • Download full GRIB2 files
  • Download subset GRIB2 files (by grib field)
  • Read data with xarray
  • Plot data with Cartopy (very early development)
from herbie.archive import Herbie

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

# Download the full GRIB2 file
H.download()

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

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

Data Sources

Herbie downloads model data from the following sources, but can be extended to include others:

  • NOMADS
  • Big Data Program Partners (AWS, Google, Azure)
  • University of Utah CHPC Pando archive

History

During my PhD at the University of Utah, I created, at the time, the only publicly-accessible archive of HRRR data. In the later half of 2020, this data was made available through the NOAA Big Data Program. This package organizes and expands my original download scripts into a more coherent package with the ability to download HRRR and RAP model data from different data sources. It will continue to evolve at my own leisure.

I originally released this package under the name "HRRR-B" because it only dealt with the HRRR data set, but I have addeed ability to download RAP data. Thus, it was rebranded with the name "Herbie" as a model download assistant. For now, it is still called "hrrrb" on PyPI because "herbie" is already taken. Maybe someday, with some time and an enticing reason, I'll add additional download capabilities.

Alternative Download Tools

As an alternative you can use rclone to download files from AWS or GCP. I quite like rclone. Here is a short rclone tutorial


Thanks for using Herbie, and Happy Racing 🏎🏁

- Brian

👨🏻‍💻 Contributing Guidelines
💬 GitHub Discussions
🚑 GitHub Issues
🌐 Personal Webpage
🌐 University of Utah HRRR archive

✒ Pando HRRR Archive citation:

Blaylock B., J. Horel and S. Liston, 2017: Cloud Archiving and Data Mining of High Resolution Rapid Refresh Model Output. Computers and Geosciences. 109, 43-50. https://doi.org/10.1016/j.cageo.2017.08.005

P.S. If you like Herbie, check out my GOES-2-go package to download GOES-East/West data and SynopticPy to download mesonet data from the Synoptic API.

Metadata

Release files for herbie-data 0.0.8

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

Source distribution (sdist)

Source distribution for herbie-data 0.0.8
File Size Uploaded
herbie-data-0.0.8.tar.gz 47.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for herbie-data 0.0.8
File Interpreter ABI Platform
herbie_data-0.0.8-py3-none-any.whl Python 3 none any Details

Total release size: 105.4 kB

Release files / herbie-data-0.0.8.tar.gz

Download URL herbie-data-0.0.8.tar.gz
Size 47.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8bf47d26560b8070e3b79db37c10740c3403c4bff03a5441df45918cd5906cb2
BLAKE2b-256 checksum
How to use checksums
371f34fe2b3ed03ed95f8ab7f66966f39033bdad165caeb9f101d845411e07b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

Release files / herbie_data-0.0.8-py3-none-any.whl

Download URL herbie_data-0.0.8-py3-none-any.whl
Size 57.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a2f2eeb237a0b69a94feb3f5131882866704303e7cf8b6a33befbcbb60a3def
BLAKE2b-256 checksum
How to use checksums
46081702fe868740d5b07a88885623e70cf689a1b2510f50cc13962b25bc480f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1
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