Welcome to xBOUT’s documentation!#
xbout provides an interface for collecting the output data
from a BOUT++ simulation into an xarray dataset in an efficient
and scalable way, as well as accessor methods for common BOUT++
analysis and plotting tasks.
Currently only in alpha (until 1.0 released) so please report any bugs, and feel free to raise issues asking questions or making suggestions.
Reference
Installation#
With pip:
pip install --user xbout
or conda:
conda install -c conda-forge xbout
You can run the tests by running pytest --pyargs xbout.
xBOUT will install the required python packages when you run one of the above install commands if they are not already installed on your system.
Examples#
You can find some example notebooks demonstrating various features of
xbout here: boutproject/xBOUT-examples