Function _join_files

src/wrf/util.py:1810–2063

Return an array object from a sequence of files using the join method. The join method creates a new leftmost dimension for the file/sequence index. In situations where there are multiple files with multiple times, and the last file contains less times than the previous files, the

(wrfseq, varname, timeidx, is_moving, meta, _key)

def _join_files(wrfseq, varname, timeidx, is_moving, meta, _key):
    """Return an array object from a sequence of files using the join
    method.

    The join method creates a new leftmost dimension for the file/sequence
    index.  In situations where there are multiple files with multiple times,
    and the last file contains less times than the previous files, the
    remaining arrays will be arrays filled with missing values.  There are
    checks in place within the wrf-python algorithms to look for these missing
    arrays, but be careful when calling compiled routines outside of
    wrf-python.

    In general, join is rarely used, so the concatenate method should be used
    for most cases.

    Args:

        wrfseq (iterable): An iterable type, which includes lists, tuples,
            dictionaries, generators, and user-defined classes.

        varname (:obj:`str`) : The variable name.

        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. The default is 0.

        is_moving (:obj:`bool`): A boolean type that indicates if the
            sequence is a moving nest.

        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.

        meta (:obj:`bool`, optional): Set to False to disable metadata and
            return :class:`numpy.ndarray` instead of
            :class:`xarray.DataArray`.  Default is True.

        _key (:obj:`int`, optional): Cache key for the coordinate variables.
            This is used for internal purposes only.  Default is None.

    Returns:

        :class:`xarray.DataArray` or :class:`numpy.ndarray`: If xarray is
        enabled and the *meta* parameter is True, then the result will be a
        :class:`xarray.DataArray` object.  Otherwise, the result will be a
        :class:`numpy.ndarray` object with no metadata.

    """
    if is_moving is None:
        is_moving = is_moving_domain(wrfseq, varname, _key=_key)
    multitime = is_multi_time_req(timeidx)
    numfiles = _get_numfiles(wrfseq)
    maxtimes = _find_max_time_size(wrfseq)

    time_idx_or_slice = timeidx if not multitime else slice(None)
    file_times_less_than_max = False