BoutDataset Accessor Methods¶

xBOUT defines a set of accessor methods on the loaded xarray.Dataset and xarray.DataArray, which are called by ds.bout.<method>.

This is where BOUT-specific data manipulation, analysis and plotting functionality is stored, for example:

ds['n'].bout.animate2D(animate_over='t', x='x', y='z')

or:

ds.bout.create_restarts(savepath='.', nxpe=4, nype=4)

See BoutDatasetAccessor and BoutDataArrayAccessor for details on the available methods.

xBOUT