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.3.1.tar.gz (220.5 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.3.1-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for grib2sail-0.3.1.tar.gz
Algorithm Hash digest
SHA256 4771f2d49392bb38b388808fb42e564c01ece95fae213299faa1d7353bb21fa6
MD5 211b152d8597196e6f1f613e750a82b7
BLAKE2b-256 eb10a954a23c4e80c8c14b90c189621c3fe0209649649bd722b477d7eef5dc03

See more details on using hashes here.

Provenance

The following attestation bundles were made for grib2sail-0.3.1.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.3.1-py3-none-any.whl.

File metadata

  • Download URL: grib2sail-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 23.6 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2eb466a0be8baba5944dc8f88c0e7e471d0ce6171d7120ee30bc8027651dedb1
MD5 77ba5f8632e7f33759b46b1d70841184
BLAKE2b-256 2fed03f03741cad8d6cbfc017673abbda2460e4f8efab0afa52d98c8e9e8d4fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for grib2sail-0.3.1-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