Installation and Getting Started

Installing from PyPi

Install earthkit-geo with python3 (>= 3.10) and pip as follows:

python3 -m pip install earthkit-geo>=1.0.0rc0

For more details on the installation please see Installation.

Import and use

For regridding, a different interface is available depending on the input data type.

High-level interface

Use it for data containing geographical information, e.g. earthkit-data field/fieldlist objects, Xarray DataArrays or Datasets.

import earthkit.data as ekd
import earthkit.geo as ekg

# get fieldlist from a sample GRIB file
ds = ekd.from_source("sample", "O32_t2.grib2").to_fieldlist()

# the target is a regular latitude-longitude grid
out_grid = {"grid": [5, 5]}

ds_res = ekg.regrid(ds, out_grid=out_grid)

Array-level interface

Use it for raw data arrays, e.g. Numpy ndarrays.

from earthkit.geo.grids.array import regrid
import numpy as np

vals = np.random.rand(320, 640)
in_grid = {"grid": [0.25, 0.25]}  # regular latitude-longitude grid
out_grid = {"grid": "O320"}  # octahedral reduced Gaussian grid

res_vals, res_grid = regrid(vals, in_grid=in_grid, out_grid=out_grid)