boutdata

pip-package of what is found in BOUT-dev/tools/pylib/boutdata. Note that BOUT-dev/tools/pylib/boutdata will likely be replaced by this repo in BOUT++ v4.3.0. See this issue, this pull request and this pull request for details.

NOTE: This package will likely be superseded by xBOUT in the near future

Dependencies

boutdata depends on boututils which again depends on netcfd4 which requires HDF5 and netcdf-4 are installed, and that the nc-config utility is in your PATH. This can be install with

sudo apt-get install libhdf5-serial-dev netcdf-bin libnetcdf-dev

in ubuntu

Install

pip install boutdata

or in a Conda environment:

conda install -c conda-forge boutdata

Examples

Reading data from dump files:

from boutdata import collect
ni = collect("Ni")

When boutdata is installed as a package (e.g. with pip or conda), a command-line program is provided as an interface to squashoutput:

$ bout-squashoutput

bout-squashoutput provides tab-completion of arguments if argcomplete is installed and activated (see https://kislyuk.github.io/argcomplete/).