API Reference Guide

Top level API functions and objects

These functions/objects can be imported directly from the top level package and are the main entry points to work with data in earthkit-data.

Function/Object

Description

from_source()

Read data from a given source and return a data object.

from_object()

Read data from a given object and return a data object.

to_target()

Write data to a given target.

create_fieldlist()

Create a fieldlist object.

create_target()

Create a target object.

create_encoder()

Create an encoder object.

concat()

Concatenate multiple data objects into a single one.

cache

A global cache object. See: Caching for more details.

config

A config object that can be used to set global configuration options for earthkit-data. See: Configuration for more details.

Top level API classes

Top level API classes

Class

Description

Field

A horizontal slice of the atmosphere/hydrosphere at a given time.

FieldList

A collection of fields.

The full API reference guide

Traverse through the API reference guide to find out more about the available functions and classes in earthkit-data.