Method load

xarray/core/dataset.py:531–579

Trigger loading data into memory and return this dataset. Data will be computed and/or loaded from disk or a remote source. Unlike ``.compute``, the original dataset is modified and returned. Normally, it should not be necessary to call this method in user code, be

(self, **kwargs)

        )

    def load(self, **kwargs) -> Self:
        """Trigger loading data into memory and return this dataset.

        Data will be computed and/or loaded from disk or a remote source.

        Unlike ``.compute``, the original dataset is modified and returned.

        Normally, it should not be necessary to call this method in user code,
        because all xarray functions should either work on deferred data or
        load data automatically. However, this method can be necessary when
        working with many file objects on disk.

        Parameters
        ----------
        **kwargs : dict
            Additional keyword arguments passed on to ``dask.compute``.

        Returns
        -------
        object : Dataset
            Same object but with lazy data variables and coordinates as in-memory arrays.

        See Also
        --------
        dask.compute
        Dataset.compute
        Dataset.load_async
        DataArray.load
        Variable.load
        """
        # access .data to coerce everything to numpy or dask arrays
        chunked_data = {
            k: v._data for k, v in self.variables.items() if is_chunked_array(v._data)
        }
        if chunked_data:
            chunkmanager = get_chunked_array_type(*chunked_data.values())

            # evaluate all the chunked arrays simultaneously
            evaluated_data: tuple[np.ndarray[Any, Any], ...] = chunkmanager.compute(
                *chunked_data.values(), **kwargs
            )

            for k, data in zip(chunked_data, evaluated_data, strict=False):
                self.variables[k].data = data

        # load everything else sequentially
        [v.load() for k, v in self.variables.items() if k not in chunked_data]

        return self

    async def load_async(self, **kwargs) -> Self:
        """Trigger and await asynchronous loading of data into memory and return this dataset.