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.0.tar.gz (220.4 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.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: grib2sail-0.3.0.tar.gz
  • Upload date:
  • Size: 220.4 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.0.tar.gz
Algorithm Hash digest
SHA256 a60bd49ed0ebddfc895f943e59e1f94af2f40aca141b336944ddf159ee06b586
MD5 79d01e3e010962e8b26292d42f058b50
BLAKE2b-256 5fc5916739f3fc1d9983205f4c8aef869f49566ba5571ac5c6b46ddb06bf7e32

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: grib2sail-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.5 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 376c46200a37a477a309416b85bdf26bd083298ca524da06af2f8ae88cf0ceb8
MD5 04e502b8c607b0dde26bc6f6f2b17e37
BLAKE2b-256 cc7833b0dbd7ea11c4c21a68b094467f7962b3d4b44ce509b765e9ee25cd760d

See more details on using hashes here.

Provenance

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