Skip to content

Commit

Permalink
Merge pull request #256 from NOAA-EMC/ejh_readme
Browse files Browse the repository at this point in the history
updated README
  • Loading branch information
jbathegit authored Jan 10, 2023
2 parents 9009c76 + e390405 commit 35d13d5
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,27 @@

## NCEPLIBS-bufr library

The NCEPLIBS-bufr library contains routines and utilites for working with the WMO BUFR format.
The NCEPLIBS-bufr library contains routines and utilites for working with the
[WMO BUFR](https://library.wmo.int/index.php?lvl=notice_display&id=10684#.Y70OSNLMJH7) format.
It is part of the [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) project.

For full documentation of the library, see https://noaa-emc.github.io/NCEPLIBS-bufr/.

## Authors

NCEP/EMC developers.
Jack Woollen, Jeff Ator, Dennis Keyser, Stacey Bender, Diane Stokes, and Ron McLaren.

Code manager: Jeff Ator

## Supported Compilers

- GNU
- Intel
- Clang

## How to Build and Install

Download tarball from
[Releases](https://github.com/NOAA-EMC/NCEPLIBS-bufr/releases) and
unpack.

<pre>
git clone https://github.com/noaa-emc/nceplibs-bufr
mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX=path1 -DMASTER_TABLE_DIR=path2 ../nceplibs-bufr
cmake -DCMAKE_INSTALL_PREFIX=path1 -DMASTER_TABLE_DIR=path2 ..
make -j4
ctest
make install
Expand All @@ -38,15 +36,6 @@ Installation of the master BUFR tables will be under `path2`, or
under `path1` if `-DMASTER_TABLE_DIR=path2` is omitted
from the above cmake command.

For Intel and GNU compilers, the library is built with three different
type/size combinations:

- "4" = 4-byte integers and 4-byte reals
- "8" = 8-byte integers and 8-byte reals
- "d" = 4-byte integers and 8-byte reals

All type/size combinations are built and installed.

If Python interoperability is desired, `-DENABLE_PYTHON=ON` can also
be added to the above cmake command. However, version 3 of Python
must be installed and available on the system.
Expand Down

0 comments on commit 35d13d5

Please sign in to comment.