cfapyx Documentation

cfapyx is an Xarray add-on module that enables the CFA-netCDF xarray engine in python.

cfapyx follows the CFA-conventions for properly formatting a CFA-netCDF file to access distributed netCDF data.

The package can be enabled in xarray when opening a CFA file using the engine=”CFA” keyword argument. This will decode your CFA-netCDF file into a properly formatted Xarray Dataset, which will lazily load your data from distributed sources when reqired for computation or plotting.

Current support is limited to local netCDF4 formatted files, but future additions will provide access to:

• UM and PP files

• S3 interface to files in Object Storage.

Details:

• Inspiration for CFA
• Xarray Engine Overview
• Fragments, Partitions and Chunks
• cfapyx Usage and Options
• CFA Creator Usage

API Reference

• CFA Creator
• CFA Backend Entrypoint
• CFA DataStore
• CFA Wrappers
• CFA Groups

Indices and Tables

• Index

• Module Index

• Search Page

Acknowledgements

cfapyx is being developed as part of a joint project between the Centre for Environmental Data Analysis (CEDA) and the NCAS Computational Modelling Services team (NCAS-CMS)