scripts.plotting.qbo
====================

.. py:module:: scripts.plotting.qbo


Functions
---------

.. autoapisummary::

   scripts.plotting.qbo.my_formatwarning
   scripts.plotting.qbo.qbo
   scripts.plotting.qbo.cosweightlat
   scripts.plotting.qbo.calcddamp
   scripts.plotting.qbo.plotpos
   scripts.plotting.qbo.plotqbotimeseries
   scripts.plotting.qbo.plotcolorbar
   scripts.plotting.qbo.blue2red_cmap


Module Contents
---------------

.. py:function:: my_formatwarning(msg, *args, **kwargs)

.. py:function:: qbo(adfobj)

   This subroutine plots...

   (1)  the times series of the 5S to 5N zonal mean U (QBOts.png)
    - this uses the same record length for each dataset and compares
      with ERA5.

   (2) the Dunkerton and Delisi QBO amplitude (QBOamp.png)
    - this uses the full record length for each dataset and compares
      with ERA5.

   Isla Simpson (islas@ucar.edu) 22nd March 2022



.. py:function:: cosweightlat(darray, lat1, lat2)

   Calculate the weighted average for an [:,lat] array over the region
   lat1 to lat2


.. py:function:: calcddamp(data)

   Calculate the Dunkerton and Delisi QBO amplitude


.. py:function:: plotpos()

   Positionings to position the plots nicely (3x4)


.. py:function:: plotqbotimeseries(fig, dat, ny, x1, x2, y1, y2, title)

   Function for plotting each QBO time series panel

   Input:

   fig = the figure axis
   dat = the data to plot of the form (time, lev)
   ny = the number of years to plot
   x1, x2, y1, y2 = plot positioning arguments



.. py:function:: plotcolorbar(fig, x1, x2, y1, y2)

   Plotting the color bar at location [x1, y1, x2-x2, y2-y1 ]


.. py:function:: blue2red_cmap(n, nowhite=False)

   combine two existing color maps to create a diverging color map with white in the middle
   n = the number of contour intervals