Welcome to xarray-eop’s documentation!

xarray_eop is an xarray backend to open and manipulate EO data products from the Copernicus Sentinel mission, in the legacy SAFE format as well as the new zarr format used by the Re-engineered python processors.

Note

This project is under active development.

Features

• specific xarray backends : [“sentinel-3”,”eop”] to be used with xarray.open_dataset function

  • sentinel-3: handles Sentinel-3 SAFE product (.SEN3)

  • eop: Generic zarr product (.zarr) following the EOPF Product Structure Format

• Use of experimental xarray-datatree to represent the overall hierarchical data

• Access products on a local filesystem or on S3 bucket

• Conversion of products from SAFE to EOP Zarr

• Create empty products based on zmetadata template

• Verification tools by comparing 2 isomorphic products

Indices and tables

• Index

• Module Index

• Search Page

Contents

• Get Started
  • Installation
  • A simple extended Path class
  • Cloud-storage credentials
  • Open Sentinel-3 SAFE product
    • Open a specific dataset using xarray.dataset
      • xr.open_dataset()
    • Open the whole SAFE product
  • Verification Tool
• Tutorial
  • Open Sentinel-3 SAFE product
    • Open a SAFE product
      • Open a specific part of the product as a dataset
        • Product stored in the local filesystem:
        • Product stored in S3 bucket
      • Open the whole SAFE product as a datatree structure
    • Open a EOPF Zarr product
      • Product stored in the filesystem
      • Product stored in S3 bucket
    • Use of the verification tool
      • Interactive mode
      • Script mode
• API
  • High Level
    • xarray_eop.open_datatree
      • open_datatree()
    • xarray_eop.EOPath
      • EOPath
        • EOPath.protocol
        • EOPath.zip
        • EOPath.__init__()
    • xarray_eop.datatree_to_uml
      • datatree_to_uml()
    • xarray_eop.create_dataset_from_zmetadata
      • create_dataset_from_zmetadata()
    • xarray_eop.create_datatree_from_zmetadata
      • create_datatree_from_zmetadata()
    • xarray_eop.get_credentials
      • get_credentials()
    • xarray_eop.get_s3filesystem
      • get_s3filesystem()
  • Low Level
    • xarray_eop.conversion.convert.product_converter
      • product_converter()
    • xarray_eop.credentials.get_credentials_from_env
      • get_credentials_from_env()
    • xarray_eop.eop.open_eop_dataset
      • open_eop_dataset()
    • xarray_eop.eop.open_eop_datatree
      • open_eop_datatree()
    • xarray_eop.sentinel3.open_safe_datatree
      • open_safe_datatree()
    • xarray_eop.utils.convert_dict_to_plantuml
      • convert_dict_to_plantuml()
    • xarray_eop.verification.compare