API

API#

High Level#

xarray_eop.open_datatree(product_urlpath, *)

Open a tree data (zarr sentinel product) from bucket or local file system, based on datatree.DataTree

xarray_eop.EOPath(*args, **kwargs)

Classe deriving from pathlib.Path supporting object-storage path and fsspec-like URL chains.

xarray_eop.datatree_to_uml(product[, name, ...])

Generate a simplified UML diagram from a datatree

xarray_eop.create_dataset_from_zmetadata(...)

Create an empty dataset from a .zmetadata file

xarray_eop.create_datatree_from_zmetadata(...)

Create a datatree from a template zmetadata structure

xarray_eop.get_credentials(url[, profile])

Get credentials given an url path For S3 protocol, it looks first for the AWS-like (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_ENDPOINT_URL) or S3-like (S3_KEY, S3_SECRET, S3_URL) environment variables, or if a profile is given

xarray_eop.get_s3filesystem(url[, profile, anon])

Get S3 File System from an url.

Low Level#

xarray_eop.conversion.convert.product_converter(...)

Convert Sentinel-3 SAFE product to the EOP zarr structure.

xarray_eop.credentials.get_credentials_from_env(url)

Get credentials from environment variable For S3 protocol, it looks for the AWS-like (AWS_ACCESS_KEY_ID,``AWS_SECRET_ACCESS_KEY``,``AWS_ENDPOINT_URL``) or S3-like (S3_KEY,``S3_SECRET``,``S3_URL``) environment variables.

xarray_eop.eop.open_eop_dataset(...[, ...])

Opens a dataset from a zarr file It is used to define the "eop" backend to xarray.open_dataset.

xarray_eop.eop.open_eop_datatree(...)

Open and decode a EOPF-like Zarr product

xarray_eop.sentinel3.open_safe_datatree(...)

Opens a Sentinel-3 SAFE product as a full datatree

xarray_eop.utils.convert_dict_to_plantuml(...)

Convert a dictionary to a UML diagram based on plantUML

xarray_eop.verification.compare