#	This routine reads version-4 RSS TMI daily files 
#
# 	filename  name of data file with path in form satname_yyyymmdd_v4.gz
#	 where satname  = name of satellite (tmi)
#	       yyyy		= year
#		   mm		= month
#		   dd		= day of month
#   missing = fill value used for missing data;
#                  if None, then fill with byte codes (251-255)

##	the output values correspond to:
#	time		time of measurement in fractional hours GMT
#	sst			sea surface temperature in deg Celsius
#	windLF		10m surface wind, low frequency, in meters/second
#	windMF		10m surface wind, medium frequency, in meters/second
#	vapor		columnar or integrated water vapor in millimeters
#	cloud		cloud liquid water in millimeters
#	rain		rain rate in millimeters/hour
#   longitude	Grid Cell Center Longitude', LON = 0.25*x_grid_location - 0.125 degrees east
#   latitude	Grid Cell Center Latitude',  LAT = 0.25*y_grid_location - 40.125
#   land		Is this land?
#   ice			Is this ice?
#   nodata		Is there no data
#
#   if you need help with this python read code, contact support@remss.com


from bytemaps import sys
from bytemaps import Dataset
from bytemaps import Verify

from bytemaps import _get_latitude


class TMIdaily(Dataset):
    """ Read daily TMI bytemaps. """
    """
    Public data:
        filename = name of data file
        missing = fill value used for missing data;
                  if None, then fill with byte codes (251-255)
        dimensions = dictionary of dimensions for each coordinate
        variables = dictionary of data for each variable
    """

    def __init__(self, filename, missing=None):
        """
        Required arguments:
            filename = name of data file to be read (string)
                
        Optional arguments:
            missing = fill value for missing data,
                      default is the value used in verify file
        """
        self.filename = filename
        self.missing = missing
        Dataset.__init__(self)

    # Dataset:

    def _attributes(self):
        return ['coordinates','long_name','units','valid_min','valid_max']

    def _shape(self):
        return (2,7,320,1440)

    def _coordinates(self):
        return ('orbit_segment','variable','latitude','longitude')
    
    def _variables(self):
        return ['time','sst','w11','w37','vap','cld','rain',
                'longitude','latitude','land','ice','nodata']

    # _default_get():
    
    def _get_index(self,var):
        return {'time' : 0,
                'sst' : 1,
                'w11' : 2,
                'w37' : 3,
                'vap' : 4,
                'cld' : 5,
                'rain' : 6,
                }[var]

    def _get_scale(self,var):
        return {'time' : 0.1,
                'sst' : 0.15,
                'w11' : 0.2,
                'w37' : 0.2,
                'vap' : 0.3,
                'cld' : 0.01,
                'rain' : 0.1,
                }[var]

    def _get_offset(self,var):
        return {'sst' : -3.0,
                }[var]

    # _get_ attributes:

    def _get_long_name(self,var):
        return {'time' : 'Fractional hour of day GMT',
                'sst' : 'Sea Surface Temperature',
                'w11' : '10m surface wind using 11 GHz channel algorithm',
                'w37' : '10m surface wind, using 37 GHz channel algorithm',
                'vap' : 'Columnar Water Vapor',
                'cld' : 'Cloud Liquid Water',
                'rain' : 'Surface Rain Rate',
                'longitude' : 'Grid Cell Center Longitude',
                'latitude' : 'Grid Cell Center Latitude',
                'land' : 'Is this land?',
                'ice' : 'Is this ice?',
                'nodata' : 'Is there no data?',
                }[var]

    def _get_units(self,var):
        return {'time' : 'Fractional hour of day GMT',
                'sst' : 'deg C',
                'w11' : 'm/s',
                'w37' : 'm/s',                
                'vap' : 'mm',
                'cld' : 'mm',
                'rain' : 'mm/hr',
                'longitude' : 'degrees east',
                'latitude' : 'degrees north',
                'land' : 'True or False',
                'ice' : 'True or False',
                'nodata' : 'True or False',
                }[var]

    def _get_valid_min(self,var):
        return {'time' : 0.0,
                'sst' : -3.0,
                'w11' : 0.0,
                'w37' : 0.0,
                'vap' : 0.0,
                'cld' : -0.05,
                'rain' : 0.0,
                'longitude' : 0.0,
                'latitude' : -40.0,
                'land' : False,
                'ice' : False,
                'nodata' : False,
                }[var]

    def _get_valid_max(self,var):
        return {'time' : 24.0,
                'sst' : 34.5,
                'w11' : 50.0,
                'w37' : 50.0,
                'vap' : 75.0,
                'cld' : 2.5,
                'rain' : 25.0,
                'longitude' : 360.0,
                'latitude' : 40.0,
                'land' : True,
                'ice' : True,
                'nodata' : True,
                }[var]

    # _get_ variables:

    def _get_latitude(self,var,bmap):
        return _get_latitude(var,bmap,nlat=320,lat0=-39.875)
        

class DailyVerify(Verify):
    """ Contains info for verification. """
    
    def __init__(self,dataset):
        self.filename = 'verify_TMI_v4.txt'
        self.ilon1 = 328
        self.ilon2 = 330
        self.ilat1 = 192
        self.ilat2 = 195       
        self.iasc = 2
        self.variables = ['time','sst','w11','w37','vap','cld','rain']
        self.startline = {'time' : 63,
                          'sst' : 69,
                          'w11' : 75,
                          'w37' : 81,
                          'vap' : 87,
                          'cld' : 93,
                          'rain' : 99 }
        Verify.__init__(self,dataset)
        

if __name__ == '__main__':
    """ Automated testing. """

    # read daily:
    tmi = TMIdaily('TMI_19990414v4.gz')
    if not tmi.variables: sys.exit('file not found')
    
    # verify daily:
    verify = DailyVerify(tmi)
    if verify.success: print('successful verification for daily')
    else: sys.exit('verification failed for daily')
    print('')

    print('all tests completed successfully')
    print('')