Skip to main content

Python package for collecting BOUT++ data

Project description


Build Status codecov Python pypi package PEP8 License

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


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


pip install boutdata

or in a Conda environment:

conda install -c conda-forge boutdata


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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boutdata-0.1.10.tar.gz (73.9 kB view hashes)

Uploaded source

Built Distribution

boutdata-0.1.10-py3-none-any.whl (77.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page