Skip to content

Commit 3a729dd

Browse files
updated README (#798)
* updated README * working on README * working on README * working on README * working on README * working on README
1 parent 9bbc9ff commit 3a729dd

File tree

1 file changed

+40
-13
lines changed

1 file changed

+40
-13
lines changed

README.md

Lines changed: 40 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
# NCEPLIBS-g2 Library
44

5-
The NCEPLIBS-g2 library reads and writes GRIB edition 2 files.
5+
The NCEPLIBS-g2 library contains Fortran code to read and write GRIB
6+
edition 2 files, and itilities to manipulate GRIB2 files.
67

78
GRIdded Binary or General Regularly-distributed Information in Binary
89
form (GRIB) is a data format for meteorological and forecast data,
@@ -12,10 +13,18 @@ edition 2 (GRIB2) was approved by the WMO is 2003.
1213
This library is part of the
1314
[NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) project.
1415

15-
For more detailed documentation see
16-
https://noaa-emc.github.io/NCEPLIBS-g2/. For the NCEP WMO GRIB2
17-
Documentation see
18-
https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/.
16+
For more detailed documentation on this library see the [NCEPLIBS-g2
17+
documentation](https://noaa-emc.github.io/NCEPLIBS-g2/). For more
18+
information about GRIB2, see the [NCEP WMO GRIB2
19+
Documentation](https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/).
20+
21+
Starting with NCEPLIBS-g2-4.0.0, this library depends on the
22+
[NCEPLIBS-g2c](https://github.com/NOAA-EMC/NCEPLIBS-g2c) library.
23+
24+
Starting with NCEPLIBS-g2-4.0.0, this library includes the utilities
25+
formerly released in
26+
[NCEPLIBS-grib_util](https://github.com/NOAA-EMC/NCEPLIBS-grib_util). The
27+
NCEPLIBS-grib_util repository is deprecated.
1928

2029
To submit bug reports, feature requests, or other code-related issues
2130
including installation and usage questions, please create a [GitHub
@@ -24,22 +33,36 @@ NCEPLIBS inquiries, contact [Edward
2433
Hartnett](mailto:edward.hartnett@noaa.gov) (secondary point of contact
2534
[Alex Richert](mailto:alexander.richert@noaa.gov)).
2635

36+
## The Utilities
37+
38+
Utility | Purpose
39+
--------|--------
40+
cnvgrib | Convert between GRIB1 and GRIB2.
41+
copygb | Copy all or part of a GRIB1 file.
42+
copygb2 | Copy all or part of a GRIB2 file.
43+
degrib2 | Inventory a GRIB2 file.
44+
grb2index | Create an index from a GRIB1 file.
45+
grbindex | Create an index from a GRIB2 file.
46+
tocgrib | Copy some GRIB2 fields to a new GRIB1 file.
47+
tocgrib2 | Copy some GRIB2 fields to a new GRIB2 file.
48+
tocgrib2super | Copy some GRIB2 fields to a new GRIB2 file with super WMO header.
49+
2750
## Related NCEPLIBS Projects
2851

2952
Repository | Notes
3053
-----------|------
54+
[NCEPLIBS-ip](https://github.com/NOAA-EMC/NCEPLIBS-ip) | Interpolation.
3155
[NCEPLIBS-w3emc](https://github.com/NOAA-EMC/NCEPLIBS-w3emc) | Coders/decoders for GRIB1
3256
[NCEPLIBS-g2c](https://github.com/NOAA-EMC/NCEPLIBS-g2c) | C implementation of the GRIB 2 functions
33-
[NCEPLIBS-grib_util](https://github.com/NOAA-EMC/NCEPLIBS-grib_util) | A collection of GRIB1 and GRIB2 utilities
3457
[NCEPLIBS-g2tmpl](https://github.com/NOAA-EMC/NCEPLIBS-g2tmpl) | Utilities for GRIB2 templates
3558

3659
## Authors
3760

3861
Harry Glahn, Kyle Gerheiser, Stephen Gilbert, Brent Gordon, Edward
39-
Hartnett, Mark Iredell, Hang Lei, Boi Vuong, and other NOAA scientists
40-
and developers.
62+
Hartnett, Mark Iredell, Hang Lei, Alyson Stahl, Boi Vuong, and other
63+
NOAA scientists and developers.
4164

42-
Code Manager: [Hang Lei](mailto:hang.lei@noaa.gov), [Ed
65+
Code Manager: [Hang Lei](mailto:hang.lei@noaa.gov), [Edward
4366
Hartnett](mailto:edward.hartnett@noaa.gov)
4467

4568
## Prerequisites
@@ -52,6 +75,8 @@ This package requires the following third party libraries:
5275
- [zlib](http://www.zlib.net/)
5376

5477
This package requires the following NCEPLIBS libraries:
78+
- [NCEPLIBS-g2c](https://github.com/NOAA-EMC/NCEPLIBS-g2c)
79+
- [NCEPLIBS-ip](https://github.com/NOAA-EMC/NCEPLIBS-ip)
5580
- [NCEPLIBS-bacio](https://github.com/NOAA-EMC/NCEPLIBS-bacio)
5681
- [NCEPLIBS-w3emc](https://github.com/NOAA-EMC/NCEPLIBS-w3emc) (optional)
5782

@@ -67,7 +92,11 @@ make install
6792

6893
## References
6994

70-
```
95+
Hartnett, E., Lei, H., Richert, A., Stahl, A., [A New API for
96+
NOAA's GRIB2
97+
Libraries](https://www.researchgate.net/publication/386906653_A_New_API_for_NOAA's_GRIB2_Libraries),
98+
American Geophysical Union (AGU) 2024.
99+
71100
Hartnett, E., Ator, J, Lei, H., Richert, A., Woollen, J., King, A.,
72101
Hartnett, A., [NCEPLIBS GRIB and BUFR Libraries: Maintaining and
73102
Modernizing NOAA's Libraries for WMO Data
@@ -84,10 +113,8 @@ NCAR Improving Scientific Software, April 2022. .
84113
Kumar, V. Krishna, Gilbert, Stephen A., [GRIB2 conversion and its
85114
usage at NCEP](docs/GRIB2_conversion_and_its_usage_at_NCEP.pdf), 14-18
86115
November 2005, 10th Workshop on Meteorological Operational Systems
87-
ECMWF User Orientation, retrieved on July 27, 2021 from
88-
https://www.yumpu.com/en/document/view/11925806/grib2-conversion-and-its-usage-at-ncep.
116+
ECMWF User Orientation.
89117

90-
```
91118
## Disclaimer
92119

93120
```

0 commit comments

Comments
 (0)