pcmdi_metrics.hadley_cell.hadley_cell_metrics

pcmdi_metrics.hadley_cell.hadley_cell_metrics(vwnd_ds, ps_ds, vwnd_var, ps_var, output_dir, model_name, time_dim='time', lon_dim='lon', lat_dim='lat', lev_dim='plev')[source]

Calculate Hadley cell meridional stream function and edge positions.

Parameters:

vwnd_ds (xr.Dataset) – Meridional wind dataset.
ps_ds (xr.Dataset) – Surface pressure dataset.
vwnd_var (str) – Variable name for meridional wind.
ps_var (str) – Variable name for surface pressure.
output_dir (str) – Directory path for output files.
model_name (str) – Model identifier for file naming.
time_dim (str, optional) – Time dimension name. Default ‘time’.
lon_dim (str, optional) – Longitude dimension name. Default ‘lon’.
lat_dim (str, optional) – Latitude dimension name. Default ‘lat’.
lev_dim (str, optional) – Pressure level dimension name. Default ‘plev’.

Returns:

dict – Dictionary with paths to output files: - ‘monthly_psi’: Monthly stream function netCDF - ‘annual_edges’: Annual edge positions netCDF - ‘clim_psi500’: Climatological 500 hPa cross section netCDF - ‘clim_plot’: Seasonal climatology PNG

Examples

>>> import xarray as xr
>>> from pcmdi_metrics.hadley_cell import hadley_cell_metrics
>>> vwnd = xr.open_mfdataset('path/to/va_*.nc')
>>> ps = xr.open_mfdataset('path/to/ps_*.nc')
>>> results = hadley_cell_metrics(
...     vwnd_ds=vwnd,
...     ps_ds=ps,
...     vwnd_var='va',
...     ps_var='ps',
...     output_dir='./output',
...     model_name='CESM2'
... )