Skip to content

A modern, tested, open source GFS model downloader built on NodeJS 🔨

License

Notifications You must be signed in to change notification settings

ISNIT0/gfs-scraper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GFS Downloader

npm Build Status codecov CodeFactor NPM License

A modern, tested, open source GFS model downloader built on NodeJS

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. It's quite old, and not a whole lot of people are proficient in perl... Hopefully TypeScript is easier to maintain and improve!

Also, making new things is fun!

TODO

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

Building

> ./build.sh

Testing

> npm t

License

MIT

About

A modern, tested, open source GFS model downloader built on NodeJS 🔨

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published