Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
EricEngle-NOAA authored Jan 22, 2024
1 parent 60330c8 commit 2d4d773
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,10 @@ grib2io is the successor to [ncepgrib2](https://github.com/jswhit/ncepgrib2) whi
## Optional Software
* [grib2io-interp](https://github.com/NOAA-MDL/grib2io-interp) 1.0.0+ - Provides ability to perform spatial interpolation via the [NCEPLIBS-ip](https://github.com/NOAA-EMC/NCEPLIBS-ip)

## NCEPLIBS Libraries
## Required External Libraries

### g2c
Beginning with grib2io v1.1.0, the [NCEPLIBS-g2c](https://github.com/NOAA-EMC/NCEPLIBS-g2c) library is no longer bundled with grib2io. Instead, grib2io will link to an external installation of g2c, which as of v1.7.0, includes the ability to build shared-object library files. Therefore, the previous "optional" compression software is no longer needed to build grib2io. The caveat to this is you are at the mercy of how g2c was built.

For macOS users, NCEPLIBS-g2c can be installed via [this Homebrew Tap](https://github.com/eengl/homebrew-nceplibs).
### NCEPLIBS-g2c
The [NCEPLIBS-g2c](https://github.com/NOAA-EMC/NCEPLIBS-g2c) library is required for grib2io. You will have to build and install this yourself, but this is not difficult. For macOS users, NCEPLIBS-g2c can be installed via [this Homebrew Tap](https://github.com/eengl/homebrew-nceplibs). If you use the Anaconda ecosystem, then you can install via `conda install -c conda-forge nceplibs-g2c`.

## Install

Expand All @@ -55,7 +53,7 @@ Once again, this assumes that NCEPLIBS-g2c has been installed. If NCEPLIBS-g2c
```
pip install grib2io
```
* From conda-forge via conda:
* From [conda-forge](https://anaconda.org/conda-forge/grib2io) via conda:

```
conda install -c conda-forge grib2io
Expand All @@ -68,7 +66,7 @@ pip install .

## Development

The intention of grib2io is to become the offical Python interface for the NCEP g2c library. Therefore, the development evolution of grib2io will mainly focus on how best to serve that purpose and its primary user's -- mainly meteorologist, physical scientists, and software developers supporting the missions within NOAA's National Weather Service (NWS) and National Centers for Environmental Prediction (NCEP).
The intention of grib2io is to become the offical Python interface for the NCEP g2c library. Therefore, the development evolution of grib2io will mainly focus on how best to serve that purpose and its primary user's -- mainly meteorologists, physical scientists, and software developers supporting the missions within NOAA's National Weather Service (NWS) and National Centers for Environmental Prediction (NCEP), and other NOAA organizations.

## Disclaimer

Expand Down

0 comments on commit 2d4d773

Please sign in to comment.