Skip to main content

Grib files downloader for sailing purposes

Project description

GRIB2Sail

GRIB2Sail

Grib files downloader for sailing purposes

Currently the supported models are:

  • AROME (001 and 0025)
  • AROME ANTILLE
  • AROME GUYANE
  • AROME INDIEN
  • AROME NOUVELLE CALEDONIE
  • AROME POLYNESIE
  • GFS (0025)

Installation

To install GRIB2Sail simply run:

pip install grib2sail

To download GRIB from meteofrance's models (Aome), you must create a free account on meteofrance.fr. The procedure is as follow:

  1. Create an account on the Météo-France API portal
  2. Subscribe to the desired service (Arome)
  3. Go to "My API" then, from your subscribed model: "Generate Token"
  4. Checkout the curl field at the bottom, it looks like :
curl -k -X POST https://portal-api.meteofrance.fr/token -d "grant_type=client_credentials" -H "Authorization: Basic ABCDEF1234abcdef"
  1. The string that comes after Basic is your application ID (ABCDEF1234abcdef in this example)
  2. Copy/paste this application ID to GRIB2Sail when prompted (you will only be prompted the first time you use GRIB2Sail)

Usage

To get the GRIB file containing the wind, the wind_gust, the atmospheric pressure and the cloud coverage for the area between latitude 11.5N - 12.5N and longitude 62.5W - 61.5W with a 3 hour step from the AROME ANTILLE model run:

python -m grib2sail --lat 11.5,12.5 --lon -62.5,-61.5 --step 3h --data wind,wind_gust,cloud,pressure

The first time you will be prompted to enter your application ID. It will be stored in your keyring for subsequent run.

The downloaded grib file will be present in the working directory named arome_antille_1970-01-01T00.00.00Z_3h.grib2.

It can now be imported in a navigation software such as OpenCPN

Roadmap

This is still the early stage of the development the main upcoming features are:

  • adding more supported models (arpege, ecmwf...)
  • adding more supported variables (rain, sea state)
  • adding a GUI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grib2sail-0.4.0.tar.gz (221.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

grib2sail-0.4.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file grib2sail-0.4.0.tar.gz.

File metadata

  • Download URL: grib2sail-0.4.0.tar.gz
  • Upload date:
  • Size: 221.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for grib2sail-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a43b4e2f924db98045a17f96c13f6920ba277a65a4c81c5de918ad70d038df5b
MD5 3121cf1a56da71bc17eeb8279e8ea43e
BLAKE2b-256 8139eea2a0256518751dad737a3b2683444ed634b22891677c7192b9ec90e275

See more details on using hashes here.

Provenance

The following attestation bundles were made for grib2sail-0.4.0.tar.gz:

Publisher: release.yml on Ch1nkara/GRIB2Sail

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file grib2sail-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: grib2sail-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for grib2sail-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 96d21404404738241428742fece551dec787e33baea0a6e7c111c62aec71e8d5
MD5 05831271df83fc9a5a6a1ff1d5f81b9e
BLAKE2b-256 05d7476dc0954ed5c18746ba9b6af3d7267c9005eac74680f9fd2fcc3b48c3b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for grib2sail-0.4.0-py3-none-any.whl:

Publisher: release.yml on Ch1nkara/GRIB2Sail

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page