grib2sail 0.2.1__tar.gz → 0.3.1__tar.gz

grib2sail-0.3.1/.github/release.yml

@@ -0,0 +1,17 @@
+changelog:
+  categories:
+    - title: "✨ Features"
+      labels:
+        - enhancement
+
+    - title: "🐛 Fixes"
+      labels:
+        - bug
+
+    - title: "📚 Documentation"
+      labels:
+        - documentation
+
+    - title: "🔧 Other"
+      labels:
+        - "*"

{grib2sail-0.2.1 → grib2sail-0.3.1}/.github/workflows/release.yml

@@ -45,4 +45,27 @@ jobs:
         path: dist/
     - name: Publish distribution to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-github:
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        persist-credentials: false
+    - name: Download all the dists
+      uses: actions/download-artifact@v6
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Create a Github Release
+      uses: softprops/action-gh-release@v2
+      with:
+        generate_release_notes: true
+        files: dist/*
+      
     

{grib2sail-0.2.1/grib2sail.egg-info → grib2sail-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grib2sail
-Version: 0.2.1
+Version: 0.3.1
 Summary: Grib files downloader for sailing purposes
 Author-email: Chinkara <poubelledechinkara@outlook.com>
 License-Expression: GPL-3.0-or-later
@@ -29,8 +29,13 @@ Dynamic: license-file
 </p>
 
 Currently the supported models are:
- - AROME
+ - AROME (001 and 0025)
  - AROME ANTILLE
+ - AROME GUYANE
+ - AROME INDIEN
+ - AROME NOUVELLE CALEDONIE
+ - AROME POLYNESIE
+ - GFS (0025)
 
 ## Installation
 
@@ -74,6 +79,6 @@ It can now be imported in a navigation software such as OpenCPN
 
 This is still the early stage of the development the main upcoming features 
 are:
- - adding more supported models (arpege, gfs, ecmwf...)
+ - adding more supported models (arpege, ecmwf...)
  - adding more supported variables (rain, sea state)
  - adding a GUI

{grib2sail-0.2.1 → grib2sail-0.3.1}/README.md

@@ -13,8 +13,13 @@
 </p>
 
 Currently the supported models are:
- - AROME
+ - AROME (001 and 0025)
  - AROME ANTILLE
+ - AROME GUYANE
+ - AROME INDIEN
+ - AROME NOUVELLE CALEDONIE
+ - AROME POLYNESIE
+ - GFS (0025)
 
 ## Installation
 
@@ -58,6 +63,6 @@ It can now be imported in a navigation software such as OpenCPN
 
 This is still the early stage of the development the main upcoming features 
 are:
- - adding more supported models (arpege, gfs, ecmwf...)
+ - adding more supported models (arpege, ecmwf...)
  - adding more supported variables (rain, sea state)
  - adding a GUI

{grib2sail-0.2.1 → grib2sail-0.3.1}/grib2sail/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.1'
-__version_tuple__ = version_tuple = (0, 2, 1)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)
 
-__commit_id__ = commit_id = 'gb3485d981'
+__commit_id__ = commit_id = 'ga099d2dc0'

{grib2sail-0.2.1 → grib2sail-0.3.1}/grib2sail/cli.py

@@ -10,9 +10,10 @@ app = typer.Typer(help='Download GRIB2 meteorological data')
 # main cli entry point
 @app.command()
 def main(
-  model: str = typer.Option(v.MODELS[0], help='|'.join(v.MODELS)),
-  step: str = typer.Option(v.STEPS[1], help='|'.join(v.STEPS)),
-  data: str = typer.Option(v.DATAS[0], help=','.join(v.DATAS)),
+  model: str = typer.Option(v.MODELS[0], help='Choose one among: ' + ', '.join(v.MODELS)),
+  step: str = typer.Option(v.STEPS[1], help='Choose one among: '  + ', '.join(v.STEPS)),
+  days: str = typer.Option(2, help='Forecast duration in days'),
+  data: str = typer.Option(v.DATAS[0], help='Choose multiple among: ' + ', '.join(v.DATAS)),
   lat: str = typer.Option(..., help='latitudes max and min ex: -7,-2'),
   lon: str = typer.Option(..., help='longitude max and min ex: -62,-60'),
   debug: bool = typer.Option(False, help='Enable debug prints'),
@@ -24,11 +25,10 @@ def main(
   logger.debug(f"latitude is now: {lat}")
   lon = parse_coord(lon)
   logger.debug(f"longitude is now: {lon}")
-  validate_input(model, step, data, lat, lon)
-  
-  logger.debug(f"model: {model}, step: {step}, data: {data}")
+  validate_input(model, step, days, data, lat, lon)
+  logger.debug(f"model: {model}, step: {step}, days: {days}, data: {data}")
   logger.info(f"Downloading from {model}: {data}")
-  download_gribs(model, step, data, lat, lon)
+  download_gribs(model, step, days, data, lat, lon)
   logger.info('Done')
 
 ## HELPER FUNCTIONS
@@ -49,12 +49,16 @@ def convert_to_nb(nb_str):
       msg = f"failed to convert to int or float: {nb_str}"
       raise typer.BadParameter(msg)
 
-def validate_input(m, s, d, lat, lon):
-  if m not in v.MODELS:
+def validate_input(model, step, days, data, lat, lon):
+  if model not in v.MODELS:
     logger.error_exit('model must be one of: ' + '|'.join(v.MODELS))
-  if s not in v.STEPS:
+  if step not in v.STEPS:
     logger.error_exit('step must be one of: ' + '|'.join(v.STEPS))
-  for elmnt in d:
+  try:
+    int(days)
+  except ValueError:
+    logger.error_exit('days must be an integer, ex --days 4')
+  for elmnt in data:
     if elmnt not in v.DATAS:
       msg = 'data must be a combinaison of: '
       logger.error_exit(msg + ','.join(v.DATAS))

{grib2sail-0.2.1 → grib2sail-0.3.1}/grib2sail/downloader.py

@@ -1,10 +1,12 @@
 from concurrent.futures import ThreadPoolExecutor, as_completed
 import threading
 import requests
+from pathlib import Path
 from rich.progress import Progress
 
 from grib2sail.logger import logger
 from grib2sail.downloader_arom import handle_fetch_error_arom, download_arom
+from grib2sail.downloader_gfs import download_gfs
 import grib2sail.variables as v
 
 thread_local = threading.local()
@@ -14,13 +16,16 @@ def get_session():
     thread_local.session = requests.Session()
   return thread_local.session
 
-def download_gribs(m, s, d, lat, lon):
-  if m.startswith('arome'):
-    download_arom(m, s, d, lat, lon)
+def download_gribs(model, step, days, data, lat, lon):
+  if model.startswith('arome'):
+    download_arom(model, step, days, data, lat, lon)
+  elif model == 'gfs':
+    download_gfs(model, step, days, data, lat, lon)
   else:
-    logger.error_exit(f"Downloader failed: unexpected model: {m}")
+    logger.error_exit(f"Downloader failed: unexpected model: {model}")
 
-def get_layers(model, urls, header):
+# Optimized resource fetcher with threading and common session
+def get_layers(model, urls, header={}):
   # Downloading every layers
   layers = [None] * len(urls)
   with Progress() as progress:
@@ -40,6 +45,7 @@ def get_layers(model, urls, header):
         progress.advance(task)
   return layers
 
+# Fetch an url and handle errors differently depending on the model
 def fetch(idx, url, headers, model):
   try:
     session = get_session()
@@ -52,3 +58,13 @@ def fetch(idx, url, headers, model):
     else:
       logger.error_exit(f"Download failed: {e}")
     return idx, None
+
+# Output the file once all the layers have been downloaded
+def write_file(model, run, step, layers):
+  file = Path(f"{model}_{run}_{step}.grib2")
+  file.unlink(missing_ok=True)
+  with open(file, "wb") as outfile:
+    for layer in layers:
+      if layer:
+        outfile.write(layer)
+

{grib2sail-0.2.1 → grib2sail-0.3.1}/grib2sail/downloader_arom.py

@@ -1,4 +1,3 @@
-from pathlib import Path
 import re
 import requests
 import time as t
@@ -9,20 +8,16 @@ import grib2sail.downloader as d
 from grib2sail.logger import logger
 from grib2sail.token import get_arome_token
 
-def download_arom(model, step, data, lat, lon):
+def download_arom(model, step, days, data, lat, lon):
   token = get_arome_token()
-  
   # Coverages list all the individual layers categories to download
   coverages = []
-  if v.DATAS[0] in data:
-    coverages += [va.AROM_DATAS['wind_u'], va.AROM_DATAS['wind_v']]
-  if v.DATAS[1] in data:
-    coverages += [va.AROM_DATAS['wind_gust']]
-  if v.DATAS[2] in data:
-    coverages += [va.AROM_DATAS['pressure']]
-  if v.DATAS[3] in data:
-    coverages += [va.AROM_DATAS['cloud']]
-  
+  for param in data:
+    if param == v.DATAS[0]:
+      coverages += [va.AROM_DATAS['wind_u'], va.AROM_DATAS['wind_v']]
+    else:
+      coverages += [va.AROM_DATAS[param]]
+
   # Get latest available forecast date from arome /GetCapabilities api endpoint
   logger.info('Finding latest available forecast')
   session = d.get_session()
@@ -55,9 +50,10 @@ def download_arom(model, step, data, lat, lon):
 
   # Select forecast prevision time based on user input
   # 3600 means layer is the prevision for 1h after latestRun
+  nbDay = 1 if days == "1" else 2
   times = list(range(
     int(step[:-1]) * 3600,
-    172800+1,
+    nbDay * 24 * 60 * 60 + 1,
     int(step[:-1]) * 3600)
   )
   logger.debug(f"Forecast to download are {times}")
@@ -95,14 +91,13 @@ def download_arom(model, step, data, lat, lon):
       if i+100 < len(urls):
         logger.info('Sleeping 1 minute...')
         t.sleep(60)
-  
-  # Output the file once all the layers have been downloaded
-  file = Path(f"{model}_{latestRun}_{step}.grib2")
-  file.unlink(missing_ok=True)
-  with open(file, "wb") as outfile:
-    for layer in layers:
-      if layer:
-        outfile.write(layer)
+
+  # Format output file name 
+  run = latestRun.replace('-', '')
+  run = re.sub(r'T(00|06|12|18)\.00\.00Z', r'-\1z', run)
+
+  # Write the grib file as the concatenation of the layers
+  d.write_file(model, run, step, layers)
 
 def handle_fetch_error_arom(e):
   if isinstance(e, requests.exceptions.HTTPError):
@@ -113,3 +108,4 @@ def handle_fetch_error_arom(e):
     logger.debug(f"Error was {e}")
   else:
     logger.error_exit(f"Download failed: {e}")
+

grib2sail-0.3.1/grib2sail/downloader_gfs.py

@@ -0,0 +1,69 @@
+from datetime import datetime, timedelta
+
+import grib2sail.variables as v
+import grib2sail.variables_gfs as vg 
+import grib2sail.downloader as d
+from grib2sail.logger import logger
+
+def download_gfs(model, step, days, data, lat, lon):
+  if int(days) > 16:
+    logger.warning(f"Requesting {days} days, max is 16")
+    days = "16"
+  # Forecast is available on an hourly basis until day 5 then on a 3h basis
+  if step == '1h' and int(days) > 5 :
+    logger.warning('Only the first 5 days can have a step of 1h, the rest will have a 3h step')
+    hours = list(range(0, 120, 1)) + list(range(120, 385, 3))
+  else:
+      hours = list(range(0, 24 * int(days) + 1, int(step[:-1])))
+
+  session = d.get_session()
+  # Get latest available forecast date and run by trying from most recent
+  logger.info('Finding latest available forecast')
+  date, run = find_latest_forecast(session, f"f{hours[-1]:03d}")
+  logger.debug(f"Latest forecast is {date}, {run}z")
+
+  # Coverages list all the individual layers categories to download
+  coverages = []
+  for param in data:
+    if param == v.DATAS[0]:
+      coverages += [vg.GFS_DATAS['wind_u'], vg.GFS_DATAS['wind_v']]
+    else:
+      coverages += [vg.GFS_DATAS[param]]
+
+  urls = []
+  for hour in hours:
+    url = vg.API_URL 
+    url += f"?dir=%2Fgfs.{date}%2F{run}%2Fatmos&file=gfs.t{run}z.pgrb2.0p25.f{hour:03d}"
+    url += ''.join(coverages) + f"&subregion="
+    url += f"&leftlon={lon[0]}&rightlon={lon[1]}" + f"&bottomlat={lat[0]}&toplat={lat[1]}"
+    urls.append(url)
+  logger.debug(f"First url to download is {urls[0]}")
+  layers = d.get_layers(model, urls)
+
+  # Write the grib file as the concatenation of the layers
+  d.write_file(model, f"{date}-{run}z", step, layers)
+
+def find_latest_forecast(session, lastLayer):
+  today = datetime.today()
+  dates = [
+    (today + timedelta(days=1)).strftime("%Y%m%d"), 
+    today.strftime("%Y%m%d"), 
+    (today - timedelta(days=1)).strftime("%Y%m%d")
+  ]
+  runs = ['18', '12', '06', '00']
+  for date in dates:
+    for run in runs:
+      url = (
+        f"{vg.PROD_URL}/gfs.{date}/{run}/atmos/"
+        f"gfs.t{run}z.pgrb2.0p25.{lastLayer}"
+      )
+      try:
+        r = session.head(url, timeout=10)
+        if r.status_code == 200:
+          return date, run 
+        else:
+          logger.debug(f"Unavailable forecast {url}, status is: {r.status_code}")
+      except Exception as e:
+        logger.error_exit(f"Download failed: {e}")
+  logger.error_exit("Couldn't find the latest available forecat")
+

grib2sail-0.3.1/grib2sail/variables.py

@@ -0,0 +1,3 @@
+MODELS = ['arome_antilles', 'arome', 'arome0025', 'arome_guyane', 'arome_indien', 'arome_ncaledonie', 'arome_polynesie', 'gfs']
+STEPS = ['1h', '3h', '6h', '12h']
+DATAS = ['wind', 'wind_gust', 'pressure', 'cloud', 'rain']

grib2sail-0.3.1/grib2sail/variables_arom.py

@@ -0,0 +1,27 @@
+import grib2sail.variables as v
+
+AROM_DATAS = {
+  'wind_u': 'U_COMPONENT_OF_WIND__SPECIFIC_HEIGHT_LEVEL_ABOVE_GROUND___',
+  'wind_v': 'V_COMPONENT_OF_WIND__SPECIFIC_HEIGHT_LEVEL_ABOVE_GROUND___',
+  'wind_gust': 'WIND_SPEED_GUST__SPECIFIC_HEIGHT_LEVEL_ABOVE_GROUND___',
+  'pressure': 'PRESSURE__MEAN_SEA_LEVEL___',
+  'cloud': 'TOTAL_CLOUD_COVER__GROUND_OR_WATER_SURFACE___'
+}
+
+AROM_URLS = {
+  'token': 'https://portail-api.meteofrance.fr/token',
+  f"{v.MODELS[0]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-ANTIL-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[1]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-001-FRANCE-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[2]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-0025-FRANCE-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[3]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-GUYANE-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[4]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-INDIEN-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[5]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-NCALED-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[6]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-POLYN-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
+  f"{v.MODELS[0]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-ANTIL-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+  f"{v.MODELS[1]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-001-FRANCE-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+  f"{v.MODELS[2]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-0025-FRANCE-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+  f"{v.MODELS[3]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-GUYANE-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+  f"{v.MODELS[4]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-INDIEN-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+  f"{v.MODELS[5]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-NCALED-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+  f"{v.MODELS[6]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-POLYN-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
+}

grib2sail-0.3.1/grib2sail/variables_gfs.py

@@ -0,0 +1,11 @@
+PROD_URL = 'https://nomads.ncep.noaa.gov/pub/data/nccf/com/gfs/prod'
+API_URL = 'https://nomads.ncep.noaa.gov/cgi-bin/filter_gfs_0p25.pl'
+
+GFS_DATAS = {
+  'wind_u': '&var_UGRD=on&lev_10_m_above_ground=on',
+  'wind_v': '&var_VGRD=on',
+  'wind_gust': '&var_GUST=on&lev_surface=on',
+  'pressure': '&var_PRMSL=on&lev_mean_sea_level=on',
+  'cloud': '&var_TCDC=on&lev_entire_atmosphere=on'
+}
+

{grib2sail-0.2.1 → grib2sail-0.3.1/grib2sail.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grib2sail
-Version: 0.2.1
+Version: 0.3.1
 Summary: Grib files downloader for sailing purposes
 Author-email: Chinkara <poubelledechinkara@outlook.com>
 License-Expression: GPL-3.0-or-later
@@ -29,8 +29,13 @@ Dynamic: license-file
 </p>
 
 Currently the supported models are:
- - AROME
+ - AROME (001 and 0025)
  - AROME ANTILLE
+ - AROME GUYANE
+ - AROME INDIEN
+ - AROME NOUVELLE CALEDONIE
+ - AROME POLYNESIE
+ - GFS (0025)
 
 ## Installation
 
@@ -74,6 +79,6 @@ It can now be imported in a navigation software such as OpenCPN
 
 This is still the early stage of the development the main upcoming features 
 are:
- - adding more supported models (arpege, gfs, ecmwf...)
+ - adding more supported models (arpege, ecmwf...)
  - adding more supported variables (rain, sea state)
  - adding a GUI

{grib2sail-0.2.1 → grib2sail-0.3.1}/grib2sail.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@
 LICENSE
 README.md
 pyproject.toml
+.github/release.yml
 .github/workflows/release.yml
 docs/assets/grib2sail_logo.png
 grib2sail/__init__.py
@@ -10,10 +11,12 @@ grib2sail/_version.py
 grib2sail/cli.py
 grib2sail/downloader.py
 grib2sail/downloader_arom.py
+grib2sail/downloader_gfs.py
 grib2sail/logger.py
 grib2sail/token.py
 grib2sail/variables.py
 grib2sail/variables_arom.py
+grib2sail/variables_gfs.py
 grib2sail.egg-info/PKG-INFO
 grib2sail.egg-info/SOURCES.txt
 grib2sail.egg-info/dependency_links.txt

grib2sail-0.2.1/grib2sail/variables.py

@@ -1,3 +0,0 @@
-MODELS = ['arome_antilles', 'arome001']
-STEPS = ['1h', '3h', '6h', '12h']
-DATAS = ['wind', 'wind_gust', 'pressure', 'cloud', 'rain']

grib2sail-0.2.1/grib2sail/variables_arom.py

@@ -1,17 +0,0 @@
-import grib2sail.variables as v
-
-AROM_DATAS = {
-  'wind_u': 'U_COMPONENT_OF_WIND__SPECIFIC_HEIGHT_LEVEL_ABOVE_GROUND___',
-  'wind_v': 'V_COMPONENT_OF_WIND__SPECIFIC_HEIGHT_LEVEL_ABOVE_GROUND___',
-  'wind_gust': 'WIND_SPEED_GUST__SPECIFIC_HEIGHT_LEVEL_ABOVE_GROUND___',
-  'pressure': 'PRESSURE__MEAN_SEA_LEVEL___',
-  'cloud': 'TOTAL_CLOUD_COVER__GROUND_OR_WATER_SURFACE___'
-}
-
-AROM_URLS = {
-  'token': 'https://portail-api.meteofrance.fr/token',
-  f"{v.MODELS[0]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-ANTIL-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
-  f"{v.MODELS[1]}_cov": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-001-FRANCE-WCS/GetCoverage?service=WCS&version=2.0.1&format=application/wmo-grib',
-  f"{v.MODELS[0]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-OM-0025-ANTIL-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
-  f"{v.MODELS[1]}_capa": 'https://public-api.meteofrance.fr/public/arome/1.0/wcs/MF-NWP-HIGHRES-AROME-001-FRANCE-WCS/GetCapabilities?service=WCS&version=1.3.0&language=eng',
-}