From 972846083d553242539673325206fce7bf15535b Mon Sep 17 00:00:00 2001 From: loeiten Date: Sun, 18 Aug 2019 18:50:32 +0200 Subject: [PATCH] Updated README with links to PRs and issues NOTE: The files are in synch with https://github.com/boutproject/BOUT-dev/commit/50e3b46b2bea4a8c207aeb7bfe9b42b89baa7969 --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c5e3832..1f2ce01 100644 --- a/README.md +++ b/README.md @@ -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` \ No newline at end of file +`pip install boututils` +