https://github.com/blaylockbk/wgrib2-docs

Unofficial documentation for wgrib2
https://github.com/blaylockbk/wgrib2-docs

documentation grib2 help-wanted wgrib2

Last synced: about 1 month ago
JSON representation

Unofficial documentation for wgrib2

• Host: GitHub
• URL: https://github.com/blaylockbk/wgrib2-docs
• Owner: blaylockbk
• Created: 2023-01-28T23:43:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-09T05:00:32.000Z (8 months ago)
• Last Synced: 2024-05-09T06:22:07.899Z (8 months ago)
• Topics: documentation, grib2, help-wanted, wgrib2
• Language: Jupyter Notebook
• Homepage: https://wgrib2-docs.readthedocs.io/en/latest/index.html
• Size: 883 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        






# Unofficial documentation for wgrib2

Wgrib2 is a utility for processing and manipulating GRIB2 files.

# [📕 Read the **wgrib2** Docs](https://wgrib2-docs.readthedocs.io/en/latest/index.html)

## Project Description

This is a remake of the original [wgrib2 documentation](https://www.cpc.ncep.noaa.gov/products/wesley/wgrib2/) . I scrapped the documentation HTML pages, converted them to Markdown, rebuilt the pages with Sphinx, and hosted them on readthedocs. These, of course, are **unofficial** documentation for wgrib2. I primarily did this because it's sometimes hard to find the right page I'm looking for in the official docs and remade the docs for mainly my own benefit. Plus, this project gave me some experience with Sphinx.

The projects goals are to

- Scrape the original wgrib2 docs and rehost on readthedocs.

- Correct any wrong information, grammar, and improve the visual presentation with additional formatting.

- Make searchable wgrib2 documentation using Sphinx.

- Logically organize the pages so things are easier to find.

- Provide more examples. Lots of examples with pictures, diagrams, and videos.

- Be open source and invite others to contribute.

## Help wanted.

**_If you would like to get involved_**, I would love your help to make _the best wgrib2 documentation ever!_ To get started, submit an Issue or Pull Request.