A NodeJS and CLI GFS Model Scraper Tool 🔨
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
example
src
.gitignore
LICENSE
README.md
build.sh
package-lock.json
package.json
tsconfig.json

README.md

GFS Scraper

Installation

> npm i -g gfsscraper

Requirements

  • *nix based OS
  • NodeJS
  • NPM

Usage

Command Line

> gfsscraper --help

> gfsscraper downloadStep --run "2018082712" --step "000" --outFile ./out.grib2 --parameterHeightGroups TMP:2maboveground LAND:surface

NodeJS

import * as gfsScraper from 'gfsscraper';

gfsScraper.downloadStep('./out.grib2', '2018082712', '000', 'all'); // Downloads all parameters and heights for selected step

gfsScraper.downloadStep('./out.grib2', '2018082712', '000', [{
    height: '2maboveground',
    parameter: 'TMP'
}, {
    height: 'surface',
    parameter: 'LAND'
}]);

See example/example.ts

Justification

The industry standard for GFS GRIB file downloading is get_gfs.pl. There's nothing particularly wrong with this, but it's a shame to have yet another language/tool to learn for new weather developers. It also doesn't scale particularly well or provide an API to other systems.

Also, making new things is fun!

TODO

  • Remove coupling to GFS (make more generic)
  • Prettier Logging
  • UI For selecting parameters (FUTURE)

Building

> ./build.sh

License

MIT