mpas_tools.ocean.compute_barotropic_streamfunction

mpas_tools.ocean.compute_barotropic_streamfunction(ds_mesh, ds, logger=None, min_depth=-5.0, max_depth=10000.0, prefix='timeMonthly_avg_', time_index=0)[source]

Compute barotropic streamfunction. Returns BSF in Sv on vertices.

Parameters:

  • ds_mesh (xarray.Dataset) – A dataset containing MPAS mesh variables

  • ds (xarray.Dataset) – A dataset containing MPAS output variables normalVelocity and layerThickness (possibly with a prefix)

  • logger (logging.Logger, optional) – A logger for the output if not stdout

  • min_depth (float, optional) – The minimum depth (positive down) to compute transport over

  • max_depth (float, optional) – The maximum depth (positive down) to compute transport over

  • prefix (str, optional) – The prefix on the normalVelocity and layerThickness variables

  • time_index (int, optional) – The time at which to index ds (if it has Time as a dimension)