Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
earthkit-data latest documentation
earthkit-data earthkit-data
  • Why earthkit-data?

User guide

  • Installation and Getting Started
  • Frequently asked questions
  • Tutorials
  • How-to guides
    • Data sources
      • The object returned by from_source
      • Reading files
      • Reading multiple files
      • Reading file parts
      • Reading files as a stream
      • Reading tar or zip archive
      • Reading data from a stream
      • Reading data from URLs
      • Reading data parts from URLs
      • Reading data from URLs as a stream
      • Reading NetCDF data from OPEnDAP services
      • Retrieving data from the ECMWF MARS archive
      • Retrieving data from the ADS
      • Retrieving data from the CDS
      • Retrieving ECMWF open data
      • Retrieving data from FDB
      • Retrieving fields with polytope
      • Retrieving features with polytope
      • Retrieving data from S3 buckets
      • Retieving data from WEkEO
    • GRIB
      • Using GRIB data
      • GRIB: listing contents
      • GRIB: getting latitudes, longitudes and values (regular LL grid)
      • GRIB: getting latitudes, longitudes and values (reduced Gaussian grid)
      • GRIB: selection using metadata
      • GRIB: ordering fields
      • GRIB: modifying values
      • GRIB: modifying metadata
      • GRIB: missing values
      • GRIB: using array namespaces
      • GRIB: nearest gridpoint
      • GRIB: generating time series
      • GRIB: writing data into FDB
      • GRIB: retrieving FDB data lazily
      • GRIB: converting to NetCDF
    • NetCDF
      • Using NetCDF data
      • NetCDF: working with fieldlists
    • BUFR
      • BUFR: using SYNOP data
      • BUFR: using TEMP data
    • ODB
      • Using ODB data
    • CoverageJSON
      • CoverageJSON: retrieving time series with Polytope
      • CoverageJSON: retrieving polygon coverages with Polytope
      • CoverageJSON: retrieving vertical profiles with Polytope
    • GeoTIFF
      • Using GeoTIFF data
    • GeoJSON/GeoPandas
      • Using GeoJSON and GeoPandas data
    • Shapefile
      • Using shapefiles
    • UK Met Office PP file
      • Using UK Met Office PP files
    • Dictionary input
      • Build fieldlist from dicts in a loop
      • list-of-dicts: overview
      • list-of-dicts: defining geography
      • list-of-dict: converting to Xarray
    • Other inputs
      • Reading data from objects
      • Using pandas data
    • Fields
      • Field overview
    • Xarray engine
      • Xarray engine: overview
      • Xarray engine: temporal dimensions
      • Xarray engine: step range
      • Xarray engine: temporal dimensions - seasonal forecast
      • Xarray engine: vertical dimensions
      • Xarray engine: ensemble data
      • Xarray engine: chemical and optical dimensions
      • Xarray engine: 2D wave spectra dimensions
      • Xarray engine: variable key
      • Xarray engine: mono variable
      • Xarray engine: mono variable with remapping
      • Xarray engine: field dimensions
      • Xarray engine: writing back to GRIB
      • Xarray engine: splitting options
      • Xarray engine: squeezing dimensions
      • Xarray engine: size-1 dimension as a variable attribute
      • Xarray engine: extra dimensions
      • Xarray engine: remapping
      • Xarray engine: auxiliary coordinates
      • Xarray engine: hypercube with holes
      • Xarray engine: chunks
      • Xarray engine: chunks on a Dask cluster
      • Xarray engine: GRIB related workflow
      • Xarray: using CuPy
    • Targets and encoders
      • Writing to a file target
      • Writing GRIB to a file target
      • Writing GRIB to file-pattern target
      • Writing GRIB to an FDB target
      • Converting GRIB to GeoTIFF
      • Writing GRIB data to Zarr
      • GRIB encoder
    • Miscellaneous
      • Configuration
      • Configuration environment variables
      • Cache policies
      • Projections
      • Demo sources plugin
  • Concepts
    • Inputs
      • Data sources
      • from_object
    • Data objects
    • Encoders
    • Targets
      • to_target
      • Target objects
    • Streams
    • Configuration
    • Caching
    • Xarray engine
      • Xarray engine: overview
      • Dimensions
      • Xarray engine: profiles
      • Profiles: earthkit
      • Profiles: mars
      • Profiles: grib
      • Profiles: None
    • Plugins overview
      • The plugin mechanism
      • Sources plugins
    • Miscellaneous
      • Using parts for file, s3 and url sources
      • Using split_on in retrieval requests
    • Field
      • Field
      • Vertical component
      • Parameter component
      • Time component
      • Ensemble component
      • Geography component
      • Processing (proc) component
    • FieldList
  • API Reference Guide
  • Frequently asked questions

Developer guide

  • Development
    • Development setup with virtualenv
    • Development setup with Conda
    • Testing
    • Documentation

Extras

  • Release Notes
    • Migration guide for 1.0.0
    • Deprecations
    • Version 1.0.0 Release Candidate Updates
    • Version 0.20 Updates
    • Version 0.19 Updates
    • Version 0.18 Updates
    • Version 0.17 Updates
    • Version 0.16 Updates
    • Version 0.15 Updates
    • Version 0.14 Updates
    • Version 0.13 Updates
    • Version 0.12 Updates
    • Version 0.11 Updates
    • Version 0.10 Updates
    • Version 0.9 Updates
    • Version 0.8 Updates
    • Version 0.7 Updates
    • Version 0.6 Updates
    • Version 0.5 Updates
    • Version 0.4 Updates
    • Version 0.3 Updates
    • Version 0.2 Updates
  • License
  • Index
Back to top
View this page
Edit this page

How-to guidesΒΆ

  • Data sources
  • GRIB
  • NetCDF
  • BUFR
  • ODB
  • CoverageJSON
  • GeoTIFF
  • GeoJSON/GeoPandas
  • Shapefile
  • UK Met Office PP file
  • Dictionary input
  • Other inputs
  • Fields
  • Xarray engine
  • Targets and encoders
  • Miscellaneous
Next
Data sources
Previous
Tutorials
Copyright © 2022-2026, European Centre for Medium-Range Weather Forecasts (ECMWF)
Made with Sphinx and @pradyunsg's Furo