==================================
:mod:`subbox` -- The subbox module
==================================

.. toctree::
   :maxdepth: 1



.. module:: subbox

For reading trimmed big-endian GISTEMP sub-box data files.

Classes
-------

  .. describe:: subboxline
  
  A single line in a subbox.
  
  Each line in a trimmed sub-box file is converted into one of these objects.
  It's a subclass of tuple; the elements of the tuple are the data items.
  The per-line metadata (latitude, longitude, etc) becomes attributes of the
  object.
  
Functions
---------

  .. function:: subboxfile (file, bos)
  
     Prepare to read records from a GISTEMP sub-box data file.
     
     This reads the header from the file, converting into into a dictionary,
     which is returned along with a iterator for the following :class:`~subbox.subboxline`
     records.
     
     
     **Return Value**
     
       A tuple of ``(header, subbox_generator)``. The ``header`` is the header
       dictionary and the ``subbox_generator`` yields a sequence of :class:`~subbox.subboxline`
       instances.