Skip to content

Commit

Permalink
Updated README with links to PRs and issues
Browse files Browse the repository at this point in the history
NOTE: The files are in synch with
boutproject/BOUT-dev@50e3b46
  • Loading branch information
loeiten committed Aug 18, 2019
1 parent e1b0229 commit 9728460
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,33 @@
[![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
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`](http://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
`boututils` depends on
[`netcfd4`](https://github.com/Unidata/netcdf4-python) which requires
[`HDF5`](http://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`
`pip install boututils`

0 comments on commit 9728460

Please sign in to comment.