{"id":18534034,"url":"https://github.com/jagoosw/getgfs","last_synced_at":"2025-10-12T01:32:01.730Z","repository":{"id":40697720,"uuid":"340361899","full_name":"jagoosw/getgfs","owner":"jagoosw","description":"getgfs extracts weather forecast variables from the NOAA GFS forecast with no obscure, platform specific, dependencies","archived":false,"fork":false,"pushed_at":"2024-07-28T10:52:56.000Z","size":3037,"stargazers_count":46,"open_issues_count":4,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-25T04:54:30.990Z","etag":null,"topics":["forecasts","gfs","python","weather","weather-api","weather-forecast"],"latest_commit_sha":null,"homepage":"https://getgfs.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jagoosw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-19T12:25:09.000Z","updated_at":"2025-08-29T06:54:13.000Z","dependencies_parsed_at":"2024-12-24T03:08:30.795Z","dependency_job_id":"484810d8-c87c-48ac-9878-136090d6621d","html_url":"https://github.com/jagoosw/getgfs","commit_stats":{"total_commits":39,"total_committers":3,"mean_commits":13.0,"dds":0.05128205128205132,"last_synced_commit":"4f2b83f146c364cbc5c1b918a9f7704781e9b490"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/jagoosw/getgfs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagoosw%2Fgetgfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagoosw%2Fgetgfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagoosw%2Fgetgfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagoosw%2Fgetgfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jagoosw","download_url":"https://codeload.github.com/jagoosw/getgfs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagoosw%2Fgetgfs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279009768,"owners_count":26084648,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["forecasts","gfs","python","weather","weather-api","weather-forecast"],"created_at":"2024-11-06T19:13:53.987Z","updated_at":"2025-10-12T01:32:01.149Z","avatar_url":"https://github.com/jagoosw.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# getgfs\n[![Tests](https://github.com/jagoosw/getgfs/actions/workflows/test.yml/badge.svg)](https://github.com/jagoosw/getgfs/actions/workflows/test.yml)[![Black Linting](https://github.com/jagoosw/getgfs/actions/workflows/black.yml/badge.svg)](https://github.com/jagoosw/getgfs/actions/workflows/black.yml)[![DOI](https://zenodo.org/badge/340361899.svg)](https://zenodo.org/badge/latestdoi/340361899)\n\n![Logo - Cloud with sun emerging from behind with text 'GetGFS' underneath](logo.png)\n\ngetgfs extracts weather forecast variables from the NOAA GFS forecast in a pure python, no obscure dependencies way. Currently you can:\n- \"Connect\" to a forecast\n- Search the variables \n- Download variables for any time range, longitude, latitude and altitude\n- Download \"wind profiles\" where you get an interpolation object for the u and v wind components by altitude\n\nFor full documentation please see the [docs](https://getgfs.readthedocs.io/en/latest/)\n\n# Installing\nInstallation is simple with PyPi:\n\n`pip install getgfs`\n\n## Requirements\nThe required libraries (installed by PyPi) are:\n\n```scipy, requests, fuzzywuzzy, numpy, python_dateutil, regex```\n\nI have tried to ensure that these are well maintained and work across platforms (as this was the motive for writing this library).\n\n# About\n\nThe incentive to write this library was that the current method to get any variable was to download and extract information from a grib file. This requires you to use the ECMWF's `ecCodes` which [doesn't work on Windows](https://github.com/ecmwf/eccodes-python#system-dependencies). To get around this the [OpenDAP](https://nomads.ncep.noaa.gov/) version of the forecast is used and a custom decoder reads the downloaded files.\n\nPrevious Python projects that attempted this do not fulfil all the requirements, mainly being an importable library. Acknowledgment must be made to [albertotb](https://github.com/albertotb)'s project [get-gfs](https://github.com/albertotb/get-gfs) for providing the first foothold along the way.\n\n# Usage\nThe library is straight forward to use. To get started create a Forecast object by:\n\n```\n\u003e\u003e\u003eimport getgfs\n\u003e\u003e\u003ef=getgfs.Forecast(\"0p25\")\n```\n\nYou can choose the resolution to be `0p25`, `0p50` or `1p00` and for the `0p25` forecast you can optional specify a shorter time step by adding `1hr` after.\n\nFirst to find what variable you are looking for use the search function, for example if I want the wind speed I could search for \"wind\":\n\n```\n\u003e\u003e\u003ef.search(\"wind\")\n[('gustsfc', '** surface wind speed (gust) [m/s] ', 100), ('ugrdprs', '** (1000 975 950 925 900.. 7 5 3 2 1) u-component of wind [m/s] ', 125), ('ugrd_1829m', '** 1829 m above mean sea level u-component of wind [m/s] ', 125), ...\n```\n\nSo now I can see I might want \"gustsfc\". Now if I want the wind speed at N70.1 W94.7 at 5:30 on the 27th of February (only forecasts going back around a week are available and future times available depend on the forecast - look for f.times) I could do:\n\n```\n\u003e\u003e\u003eres=f.get([\"gustsfc\"],\"20210227 5:30\", 70.1,-94.7)\n\u003e\u003e\u003eres.variables[\"gustsfc\"].data\narray([[[18.808477]]])\n```\n\nYou can get more information (e.g. what is the units of this) by exploring the variables information\n\n```\u003e\u003e\u003ef.variables[\"gustsfc\"]\n{'_FillValue': 9.999e+20, 'missing_value': 9.999e+20, 'long_name': '** surface wind speed (gust) [m/s] ', 'level_dependent': False}\n```\n\nYou can also get multiple variables by including more names in the list or a range of positions by using \"'[min_lat:max_lat]'\" type strings in place of the position parameters.\n\n\n## Contributing\nPlease see [contributing](CONTRIBUTING.md) for more information.\n\n# Todo\n- Add historical forecasts from https://www.ncei.noaa.gov/thredds/dodsC/model-gfs-004-files-old/202003/20200328/gfs_4_20200328_1800_384.grb2.das\n- Add export to .nc file with netcdf4 (maybe an optional dependency)\n- Add purge missing/unreliable (missing/unreliable fill values are provided but have to iterate through data to check probably)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjagoosw%2Fgetgfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjagoosw%2Fgetgfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjagoosw%2Fgetgfs/lists"}