Source code for vacumm.data.model.hycom

#!/usr/bin/env python
# -*- coding: utf8 -*-
#
# Copyright or © or Copr. Actimar/IFREMER (2012-2017)
#
# This software is a computer program whose purpose is to provide
# utilities for handling oceanographic and atmospheric data,
# with the ultimate goal of validating the MARS model from IFREMER.
#
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software.  You can  use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
#
# As a counterpart to the access to the source code and  rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty  and the software's author,  the holder of the
# economic rights,  and the successive licensors  have only  limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading,  using,  modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean  that it is complicated to manipulate,  and  that  also
# therefore means  that it is reserved for developers  and  experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and,  more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
#



__author__ = 'Stephane Raynaud'
__email__ = 'raynaud@actimar.fr'
__date__ = '2012-02-12'
__doc__ = 'HYCOM model data manipulation'


from vacumm.data import register_dataset
from vacumm.data.misc.dataset import OceanDataset, AtmosSurfaceDataset


class HYCOMZ(OceanDataset,AtmosSurfaceDataset):
    """:class:`~vacumm.data.misc.dataset.Dataset` class to read the
    HYCOM ocean model outputs

    Read the :class:`~vacumm.data.misc.dataset.Dataset` for more information
    """
    name = 'hycomz'
    domain='ocean'
    description = 'HYCOM ocean model in Z coordinates (from http://www.hycom.org)'

    ncobj_specs = {

        # Time
        'time':{'search':{'id':['mt']}},

        # salinity
        'kz':{'search':{'id':['kzm']}},

        # Sea surface temperature
        'sst':{
            'inherit':'temp',
            'select':{'level':slice(0, 1)},
            'squeeze':'z',
        }
        ,
        # Sea surface salinity
        'sss':{
            'inherit':'sal',
            'select':{'level':slice(0, 1)},
            'squeeze':'z',
        },

        # Zonal velocity
        'u3d':{
            'id': 'u'
        },

        # Meridional velocity
        'v3d':{
            'id': 'v'
        },

        # Sea surface zonal velocity
        'usurf':{
            'inherit':'u3d',
            'select':{'level':slice(0, 1)},
            'squeeze':'z',
        }
        ,
        # Sea surface meridional velocity
        'vsurf':{
            'inherit':'v3d',
            'select':{'level':slice(0, 1)},
            'squeeze':'z',
        }
    }


    positive = 'down'

# Register the class
register_dataset(HYCOMZ)
register_dataset(HYCOMZ, 'hycom') # backward compat for the moment