search

NOAA-MDL / grib2io

Python interface to the NCEP G2C Library for reading and writing GRIB2 messages.
https://noaa-mdl.github.io/grib2io
MIT License
33 stars 12 forks source link

User documentation for the project #91

Closed wxguy closed 1 year ago

wxguy commented 1 year ago

The official website for documentation of this project is https://noaa-mdl.github.io/grib2io. But the link is all about developer documentation. In addition, there is not even a single example given there.

Therefore, I propose to have user documentation for this package (similar to what pygrib or wrf-python have) and the dev documentation may be kept at the end of it. Ideally the user documentation should have a few sample data sets and example scripts (even with comments are fine) for some use cases.

EricEngle-NOAA commented 1 year ago

Thank you for this. We will work to make this better. In the meantime, there is a notebook in the project repo that demonstrates version 2.0 usage: https://github.com/NOAA-MDL/grib2io/blob/master/grib2io-v2-demo.ipynb

wxguy commented 1 year ago

Thank you for this. We will work to make this better. In the meantime, there is a notebook in the project repo that demonstrates version 2.0 usage: https://github.com/NOAA-MDL/grib2io/blob/master/grib2io-v2-demo.ipynb

Perfect. This should have been in the introduction section of official documentation.

Thank you.