Function get_pyngl

src/wrf/util.py:3614–3680

Return a :class:`Ngl.Resources` object for the map projection. Args: var (:class:`xarray.DataArray`, optional): A :class:`xarray.DataArray` variable that includes latitude,longitude coordinate information. If not used, then *wrfin* must be provided. geo

(var=None, wrfin=None, varname=None, timeidx=0, method="cat",
              squeeze=True, cache=None, **kwargs)

def get_pyngl(var=None, wrfin=None, varname=None, timeidx=0, method="cat",
              squeeze=True, cache=None, **kwargs):
    """Return a :class:`Ngl.Resources` object for the map projection.

    Args:

        var (:class:`xarray.DataArray`, optional): A :class:`xarray.DataArray`
            variable that includes latitude,longitude coordinate information.
            If not used, then *wrfin* must be provided.

        geobounds (:class:`wrf.GeoBounds`, optional):  The geobounds to
            get the extents.  If set to None and using the *var* parameter,
            the geobounds will be taken from the variable.  If using a
            file, then the geobounds will be taken from the native grid.

        wrfin (:class:`netCDF4.Dataset`, :class:`Nio.NioFile`, or an \
            iterable, optional): WRF-ARW NetCDF
            data as a :class:`netCDF4.Dataset`, :class:`Nio.NioFile`
            or an iterable sequence of the aforementioned types. If not used,
            then *var* must be provided.

        varname (:obj:`str`, optional): If using *wrfin*, then this will be the
            variable name to use to determine the geobounds.  The variable
            can be a coordinate variable, or a regular variable that contains
            coordinate attributes.  If None,
            then the 'XLAT', 'XLAT_M', 'XLONG', 'XLONG_M' variables
            will be used.

        timeidx (:obj:`int` or :data:`wrf.ALL_TIMES`, optional): The
            desired time index. This value can be a positive integer,
            negative integer, or
            :data:`wrf.ALL_TIMES` (an alias for None) to return
            all times in the file or sequence. Default is 0.

        method (:obj:`str`, optional): The aggregation method to use for
            sequences.  Must be either 'cat' or 'join'.
            'cat' combines the data along the Time dimension.
            'join' creates a new dimension for the file index.
            The default is 'cat'.

        squeeze (:obj:`bool`, optional): Set to False to prevent dimensions
            with a size of 1 from being automatically removed from the shape
            of the output. Default is True.

        cache (:obj:`dict`, optional): A dictionary of (varname, ndarray)
            that can be used to supply pre-extracted NetCDF variables to the
            computational routines.  It is primarily used for internal
            purposes, but can also be used to improve performance by
            eliminating the need to repeatedly extract the same variables
            used in multiple diagnostics calculations, particularly when using
            large sequences of files.
            Default is None.

        **kwargs: Additional PyNGL resources to set while creating the
            :class:`Ngl.Resources` object.

    Returns: