xbout.lazyload.lazy_open_boutdataset

xbout.lazyload.lazy_open_boutdataset(datapath, keep_xboundaries=False, keep_yboundaries=False, is_restart=False, info=False, **kwargs)

Open a multi-file dataset by only opening one file. Dask chunks are created for all processors using the metadata read from the first file.

datapathstr or Path

Directory containing the BOUT++ data files

keep_xboundariesbool, optional

If true, keep x-direction boundary cells (the cells past the physical edges of the grid, where boundary conditions are set); increases the size of the x dimension in the returned data-set. If false, trim these cells.

keep_yboundariesbool, optional

If true, keep y-direction boundary cells (the cells past the physical edges of the grid, where boundary conditions are set); increases the size of the y dimension in the returned data-set. If false, trim these cells.

Parameters:

• keep_xboundaries (bool)

• keep_yboundaries (bool)

• is_restart (bool)

• info (bool)