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
  • AROME ANTILLE

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, gfs, 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.2.1.tar.gz (218.6 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.2.1-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for grib2sail-0.2.1.tar.gz
Algorithm Hash digest
SHA256 fe39cc3a68b93ae9e2fd8beb54b5187069783e5a55699984b13472bc0f740bda
MD5 7bb8b663c33e92dcefa6b242ab479b03
BLAKE2b-256 771489286cd15f26774732f692f5b9b6a00332f40c4499465a783183b35bbda2

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: grib2sail-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 21.4 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5af1dcb5f67ff40528b966d04884ec835cadd30f83146d96bd68bf0cb995c2ee
MD5 44d6c128b9c8afa70f9061967eceef58
BLAKE2b-256 b2ea287ad3d44a94eb378706755a83f7793cd29699450c1032e0717c77f79794

See more details on using hashes here.

Provenance

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