xradar icon indicating copy to clipboard operation
xradar copied to clipboard

Module Design

Open mgrover1 opened this issue 2 years ago • 10 comments

Let's think about the design!

We would like users to be able to use the following:

import xarray as xr
import xradar

ds = xr.open_dataset("some_radar_data.nc", engine="xradar")

This would return a datatree, with a tree which contains datasets.

We should use the xwrf package as an inspiration here - https://github.com/xarray-contrib/xwrf, which uses a similar approach and API design.

The general xradar reader here would contain the different formats within it (ex. ODIM_H5, CfRadial1, CfRadial2).

General API

One decision we need to make is whether we should make functionality:

  • Read + return an xradar object (ex. calculate_kdp(xradar) --> xradar)
  • Operate on the xradar dataset (ex. xradar.kdp())

mgrover1 avatar Sep 01 '22 10:09 mgrover1