forked from blaylockbk/Herbie
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request blaylockbk#308 from blaylockbk/reorganize-docs
Reorganize docs: spring cleaning 🌷🧹
- Loading branch information
Showing
61 changed files
with
165 additions
and
151 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,8 @@ | ||
:orphan: | ||
|
||
404: Page Not Found | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
[Back to Herbie docs](https://herbie.readthedocs.io/) | ||
Back to Herbie docs: https://herbie.readthedocs.io/ | ||
|
||
.. image:: _static/empty.png |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,8 @@ Docstring reference for the ``herbie`` module | |
:maxdepth: 2 | ||
|
||
core | ||
fast | ||
accessors | ||
fast | ||
latest | ||
wgrib2 | ||
misc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
============= | ||
herbie.latest | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
.. currentmodule:: herbie.latest | ||
|
||
.. autosummary:: | ||
:toctree: _autosummary | ||
|
||
HerbieLatest | ||
HerbieWait |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
docs/user_guide/history.md → docs/user_guide/background/history.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
# 📜 History | ||
# 📜 Herbie's History | ||
|
||
👨🏻🎓 During my PhD at the University of Utah, I created, at the time, the only publicly accessible archive of HRRR data. Over 1,000 research scientists and professionals used that archive. In the latter half of 2020, the HRRR data was made available through the [NOAA Open Data Dissemination Program](https://www.noaa.gov/information-technology/open-data-dissemination) (formerly the NOAA Big Data Program). The Herbie package organizes and expands my original download scripts into a more coherent package with the extended ability to download more than just the HRRR and RAP model data and from different data sources. It will continue to evolve at my own leisure. | ||
|
||
> I wrote a paper about archiving HRRR data in the cloud | ||
> | ||
> > Blaylock B., J. Horel and S. Liston, 2017: Cloud Archiving and Data Mining of High-Resolution Rapid Refresh Model Output. Computers and Geosciences. 109, 43-50. <https://doi.org/10.1016/j.cageo.2017.08.005>. | ||
![alt text](../_static/timeline.png) | ||
![alt text](../../_static/timeline.png) | ||
|
||
**🌹 What's in a name?** I originally released this package under the name "HRRR-B" because it only dealt with the HRRR dataset, and the "B" was for Brian. I added the ability to access data from many more models. Thus, it was re-branded with the name "Herbie," named after a favorite childhood movie. | ||
|
||
![](../_static/Herbie3.png) | ||
![](../../_static/Herbie3.png) |
82 changes: 21 additions & 61 deletions
82
docs/user_guide/model_info.md → .../user_guide/background/model-info/hrrr.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,21 @@ | ||
# ℹ Model Info | ||
|
||
References to information about each model. | ||
|
||
> This is a work in progress. Please help with a PR 😄. Please provide links to the model homepages and GitHub links, contact for model developers, | ||
## HRRR: High Resolution Rapid Refresh | ||
|
||
- [HRRR Homepage (ESRL)](https://rapidrefresh.noaa.gov/hrrr/ "Details about the HRRR model and graphics for the most recent runs.") | ||
- [GSL-Regional-Model-Forum (GitHub)](https://github.com/NOAA-GSL/GSL-Regional-Model-Forum/discussions/ "Ask the HRRR model developers and the community about the HRRR model.") | ||
|
||
> Dowell, D. C., and Coauthors, 2022: The High-Resolution Rapid Refresh (HRRR): An Hourly Updating Convection-Allowing Forecast Model. Part I: Motivation and System Description. Wea. Forecasting, **37**, 1371–1395, <https://doi.org/10.1175/WAF-D-21-0151.1>. | ||
> James, E. P., and Coauthors, 2022: The High-Resolution Rapid Refresh (HRRR): An Hourly Updating Convection-Allowing Forecast Model. Part II: Forecast Performance. Wea. Forecasting, **37**, 1397–1417, <https://doi.org/10.1175/WAF-D-21-0130.1>. | ||
> James, E. P., and S. G. Benjamin, 2017: Observation system experiments with the hourly updating Rapid Refresh model using GSI hybrid ensemble-variational data assimilation. Mon. Wea. Rev., **145**, 2897–2918, <https://doi.org/10.1175/MWR-D-16-0398.1>. | ||
|
||
```{mermaid} | ||
gantt | ||
title HRRR Version History | ||
axisFormat %Y | ||
HRRRv1 : 2014-09-30, 2016-08-23 | ||
HRRRv2 : after v1, 2018-07-12 | ||
HRRRv3 : after v2, 2020-12-02 | ||
HRRRv4 :active, after v3 2020-12-02, 2024-11-01 | ||
RRFS : after v4, 2026 | ||
``` | ||
|
||
|
||
## RAP: Rapid Refresh | ||
|
||
ESRL: https://rapidrefresh.noaa.gov/ | ||
|
||
NCEI: https://www.ncei.noaa.gov/products/weather-climate-models/rapid-refresh-update | ||
|
||
AWS: https://registry.opendata.aws/noaa-rap/ | ||
|
||
> Benjamin, S. G., and Coauthors, 2004: An Hourly Assimilation–Forecast Cycle: The RUC. Mon. Wea. Rev., 132, 495–518, [https://doi.org/10.1175/1520-0493(2004)132<0495:AHACTR>2.0.CO;2](https://doi.org/10.1175/1520-0493(2004)132<0495:AHACTR>2.0.CO;2). | ||
> Benjamin, S. G., and Coauthors, 2016: A North American Hourly Assimilation and Model Forecast Cycle: The Rapid Refresh. Mon. Wea. Rev., **144**, 1669–1694, <https://doi.org/10.1175/MWR-D-15-0242.1>. | ||
```{mermaid} | ||
gantt | ||
title RAP Model Sources | ||
axisFormat %Y | ||
section NCEI | ||
RUC : 2005-01-01, 2012-05-01 | ||
RAP : 2012-05-01, 2022-05-01 | ||
section Big Data Program | ||
RAP : 2021-02-22, 2022-02-22 | ||
``` | ||
|
||
|
||
|
||
|
||
## GFS: | ||
|
||
## GEFS: | ||
|
||
## ECMWF: | ||
# HRRR: High Resolution Rapid Refresh | ||
|
||
- [HRRR Homepage (ESRL)](https://rapidrefresh.noaa.gov/hrrr/ "Details about the HRRR model and graphics for the most recent runs.") | ||
- [GSL-Regional-Model-Forum (GitHub)](https://github.com/NOAA-GSL/GSL-Regional-Model-Forum/discussions/ "Ask the HRRR model developers and the community about the HRRR model.") | ||
|
||
> Dowell, D. C., and Coauthors, 2022: The High-Resolution Rapid Refresh (HRRR): An Hourly Updating Convection-Allowing Forecast Model. Part I: Motivation and System Description. Wea. Forecasting, **37**, 1371–1395, <https://doi.org/10.1175/WAF-D-21-0151.1>. | ||
> James, E. P., and Coauthors, 2022: The High-Resolution Rapid Refresh (HRRR): An Hourly Updating Convection-Allowing Forecast Model. Part II: Forecast Performance. Wea. Forecasting, **37**, 1397–1417, <https://doi.org/10.1175/WAF-D-21-0130.1>. | ||
> James, E. P., and S. G. Benjamin, 2017: Observation system experiments with the hourly updating Rapid Refresh model using GSI hybrid ensemble-variational data assimilation. Mon. Wea. Rev., **145**, 2897–2918, <https://doi.org/10.1175/MWR-D-16-0398.1>. | ||
```{mermaid} | ||
gantt | ||
title HRRR Version History | ||
axisFormat %Y | ||
HRRRv1 : 2014-09-30, 2016-08-23 | ||
HRRRv2 : after v1, 2018-07-12 | ||
HRRRv3 : after v2, 2020-12-02 | ||
HRRRv4 :active, after v3 2020-12-02, 2024-11-01 | ||
RRFS : after v4, 2026 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
============== | ||
ℹ Model Info | ||
============== | ||
|
||
References to information about each model (links to the model homepages, and GitHub links, contact for model developers, etc.) | ||
|
||
**This is a work in progress. Please help with a PR 😄** | ||
|
||
|
||
.. toctree:: | ||
:glob: | ||
:maxdepth: 1 | ||
|
||
./* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# RAP: Rapid Refresh | ||
|
||
ESRL: https://rapidrefresh.noaa.gov/ | ||
|
||
NCEI: https://www.ncei.noaa.gov/products/weather-climate-models/rapid-refresh-update | ||
|
||
AWS: https://registry.opendata.aws/noaa-rap/ | ||
|
||
> Benjamin, S. G., and Coauthors, 2004: An Hourly Assimilation–Forecast Cycle: The RUC. Mon. Wea. Rev., 132, 495–518, [https://doi.org/10.1175/1520-0493(2004)132<0495:AHACTR>2.0.CO;2](https://doi.org/10.1175/1520-0493(2004)132<0495:AHACTR>2.0.CO;2). | ||
> Benjamin, S. G., and Coauthors, 2016: A North American Hourly Assimilation and Model Forecast Cycle: The Rapid Refresh. Mon. Wea. Rev., **144**, 1669–1694, <https://doi.org/10.1175/MWR-D-15-0242.1>. | ||
```{mermaid} | ||
gantt | ||
title RAP Model Sources | ||
axisFormat %Y | ||
section NCEI | ||
RUC : 2005-01-01, 2012-05-01 | ||
RAP : 2012-05-01, 2022-05-01 | ||
section Big Data Program | ||
RAP : 2021-02-22, 2022-02-22 | ||
``` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 4 additions & 4 deletions
8
docs/user_guide/disclaimer.md → docs/user_guide/housekeeping/disclaimer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,14 @@ | ||
# 👨🏻🏭 Disclaimer | ||
# 👨🏻🏭 Disclaimer & Contributing Guide | ||
|
||
Herbie continues to evolve and is distributed _as is_. I do not make any guarantee it will work for you out of the box or is tailored to your needs. Honestly, this package is my playground for developing my python skills and testing new ideas in my free time. | ||
|
||
With that said, I am happy to share this project with you. If this is helpful to you in any way, I'm glad. You are welcome to open issues when you see a problem, ask questions in the discussion, submit pull requests if you want to add a new feature or fix a bug. | ||
With that said, I am happy to share this project with you. If this is helpful to you in any way, I'm glad. You are welcome to open issues when you see a problem, ask questions in the discussion, submit pull requests if you want to add a new feature or fix a bug, and improve the documentation. I really appreciate the communities help and have learned a lot from you. | ||
|
||
🙋🏻♂️ Questions: [GitHub Discussions](https://github.com/blaylockbk/Herbie/discussions) | ||
🚑 Support: [GitHub Issues](https://github.com/blaylockbk/Herbie/issues) | ||
|
||
**Thanks for using Herbie, and happy racing 🏁** | ||
\- Brian | ||
*Thanks for using Herbie, and happy racing* | ||
*🏁 Brian* | ||
|
||
![](https://raw.githubusercontent.com/blaylockbk/Herbie/master/images/herbie.jpg) | ||
|
File renamed without changes.
File renamed without changes.
14 changes: 11 additions & 3 deletions
14
docs/user_guide/style_guide.md → docs/user_guide/housekeeping/style_guide.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,45 @@ | ||
# 🎨 Style Guide | ||
|
||
Herbie is a race car themed Python package. | ||
|
||
## Font | ||
|
||
Franklin Gothic Heavy | ||
|
||
## Colors | ||
|
||
### Red : #88211b | ||
|
||
<div style="height: 30px; width: 30px; border: 2px solid black; background-color: #88211b;"></div> | ||
|
||
- Left racing stripe, half the width of blue racing stripe | ||
- Left racing stripe, half the width of blue racing stripe | ||
|
||
### White : #ffffff | ||
|
||
<div style="height: 30px; width: 30px; border: 2px solid black; background-color: #ffffff;"></div> | ||
|
||
- Font color if background color is Tan. | ||
- (optional) center racing stripe, half the width of blue racing stripe. If omitted, background color should be Tan or White. | ||
|
||
### Blue: #0c3576 | ||
|
||
<div style="height: 30px; width: 30px; border: 2px solid black; background-color: #0c3576;"></div> | ||
|
||
- Right racign stripe, twice as wide as red racing strip | ||
|
||
### Tan: #d8c89d | ||
|
||
<div style="height: 30px; width: 30px; border: 2px solid black; background-color: #d8c89d;"></div> | ||
|
||
- Font color if background color is white. | ||
|
||
### Black: #000000 | ||
|
||
<div style="height: 30px; width: 30px; border: 2px solid black; background-color: #000000;"></div> | ||
|
||
- Text outline | ||
|
||
## Samples | ||
|
||
<img src="../_static/logo_new/Herbie-logo.png" style='background-color:transparent;'> | ||
<img src="../_static/logo_new/Herbie-logo-white.png" style='background-color:transparent;'> | ||
<img src="../../_static/logo_new/Herbie-logo.png" style='background-color:transparent;'> | ||
<img src="../../_static/logo_new/Herbie-logo-white.png" style='background-color:transparent;'> |
Oops, something went wrong.