octahedral
==========

.. py:module:: octahedral


Functions
---------

.. autoapisummary::

   octahedral.calculate_row_heights
   octahedral.plot_octahedral_grid


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

.. py:function:: calculate_row_heights(lats)

   Calculate the heights of latitude rows such that each latitude
   value lies in the center of its row, with row boundaries equidistant
   between consecutive latitudes.

   :param lats: An array of latitude values.
   :type lats: array-like

   :returns: An array containing the heights of each row.
   :rtype: numpy.ndarray


.. py:function:: plot_octahedral_grid(lons, lats, data, ax, style=None, **kwargs)

   Plot an octahedral reduced Gaussian grid using PolyCollection with given assumptions.

   :param lats: 1D array of latitudes.
   :type lats: array
   :param lons: 1D array of longitudes.
   :type lons: array
   :param data: 1D data array.
   :type data: 1D array