flextest.flexread.read_header.Header Class Reference

Inheritance diagram for flextest.flexread.read_header.Header:

Collaboration diagram for flextest.flexread.read_header.Header:

Public Member Functions
def	__init__
def	lonlat
def	read_grid
def	fill_backward
def	add_trajectory
def	add_fires
def	closest_dates
def	closest_date
Public Member Functions inherited from flextest.flexread.read_header.Structure
def	__getattr__
def	__setattr__
def	__dir__
def	set_with_dict
def	__dir__

Public Attributes
	version
	longitude
	latitude
	FD
	trajectory
	fires

Detailed Description

This is the primary starting point for processing FLEXPART output.
The Header class ( :class:`Structure` ) behaves like a dictionary. 
It contains all the metadata from the simulation run as read from the
"header" or "header_nest" binary files from the model output.

This version is using the BinaryFile class rather than FortFlex. 

Usage::

    > H = pf.Header(inputpath)
    > H.keys() #provides a list of keys available

Returns a dictionary

    H = dictionary like object with all the run metadata. TODO: Fill in keys.

    
Arguments

  .. tabularcolumns::  |l|L|

  ==============        ========================================
  keyword               Description [default]
  ==============        ========================================
  path                  path to the run directory
  headerfile            name of the header file if non standard
  readheader_ops        optional dictionary to pass readheader
  ==============        ========================================

Arguments for readheader_ops

  .. tabularcolumns::  |l|L|

  =============       ========================================
  keyword             Description [default]
  =============       ========================================
  pathname            FLEXPART run output directory
  readp               read release points 0=no, [1]=y
  nested              nested output True or [False]
  version             version of FLEXPART, default = 'V8'
  =============       ========================================
  

.. note::
    **This function is in development**

    This function is being developed so that there is no dependence on
    using f2py to compile the FortFlex module. It is working using the
    :class:`BinaryFile`, but is notably slower than :class:`FortFlex`. 
    Please report any bugs found.

Definition at line 778 of file read_header.py.

Constructor & Destructor Documentation

def flextest.flexread.read_header.Header.__init__	(		self,
			path = None,
			headerfile = None,
			version = 'V8',
			readheader_ops
	)

Definition at line 834 of file read_header.py.

    def __init__(self, path=None, headerfile=None, version='V8', **readheader_ops):
        """

        
        """
        try:
            h = read_header(path, **readheader_ops)
            self.set_with_dict(h)
            self.lonlat()
            self.version = 'V8'
        except:
            traceback.print_exc()
            raise IOError('''
            Could not set header variables.
            Does the `header` file exist in path?\n{0}'''.format(path))
            
        

Here is the call graph for this function: