Metadata-Version: 2.1
Name: boututils
Version: 0.1.10
Summary: Python package containing BOUT++ utils
Home-page: https://github.com/boutproject/boututils
Author: Ben Dudson et al.
Project-URL: Bug Tracker, https://github.com/boutproject/boututils/issues/
Project-URL: Documentation, https://bout-dev.readthedocs.io/en/latest/
Project-URL: Source Code, https://github.com/boutproject/boututils/
Keywords: bout++,bout,plasma,physics,data-extraction,data-analysis,data-visualization
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: netCDF4
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: hdf5
Requires-Dist: h5py ; extra == 'hdf5'
Provides-Extra: mayavi
Requires-Dist: mayavi ; extra == 'mayavi'
Requires-Dist: PyQt5 ; extra == 'mayavi'

# boututils

[![Build Status](https://travis-ci.org/boutproject/boututils.svg?branch=master)](https://travis-ci.org/boutproject/boututils)
[![codecov](https://codecov.io/gh/boutproject/boututils/branch/master/graph/badge.svg)](https://codecov.io/gh/boutproject/boututils)
[![Python](https://img.shields.io/badge/python->=3.6-blue.svg)](https://www.python.org/)
[![pypi package](https://badge.fury.io/py/boututils.svg)](https://pypi.org/project/boututils/)
[![PEP8](https://img.shields.io/badge/code%20style-PEP8-brightgreen.svg)](https://www.python.org/dev/peps/pep-0008/)
[![License](https://img.shields.io/badge/license-LGPL--3.0-blue.svg)](https://github.com/boutproject/boututils/blob/master/LICENSE)

pip-package of what was previously found in `BOUT-dev/tools/pylib/boututils` Note that
`BOUT-dev/tools/pylib/boututils` will likely be replaced by this repo in
`BOUT++ v4.3.0`. See [this issue](https://github.com/boutproject/BOUT-dev/issues/1347),
[this pull request](https://github.com/boutproject/BOUT-dev/pull/1766) and
[this pull request](https://github.com/boutproject/BOUT-dev/pull/1740) for details.

> **NOTE**: This package will likely be superseded by
> [`xBOUT`](https://github.com/boutproject/xBOUT) in the near future

# Dependencies

`boututils` depends on [`netcfd4`](https://github.com/Unidata/netcdf4-python) which
requires [`HDF5`](https://www.h5py.org) and
[`netcdf-4`](https://github.com/Unidata/netcdf-c/releases) 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 boututils`
