Skip to content

Commit

Permalink
Resolved conflict by keeping the deletion of gefs.ipynb
Browse files Browse the repository at this point in the history
  • Loading branch information
karlwx committed Jul 22, 2024
2 parents bddad77 + 2c18932 commit 43da859
Show file tree
Hide file tree
Showing 119 changed files with 34,430 additions and 28,008 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/tests-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,19 @@ jobs:
if: runner.os == 'Linux'
run: |
pip3 install --requirement=requirements-test.txt
pip3 install --editable=.
pip3 install --editable='.[extras]'
- name: Install project (macOS)
if: runner.os == 'macOS'
run: |
pip3 install --break-system-packages --requirement=requirements-test.txt
pip3 install --break-system-packages --editable=.
pip3 install --break-system-packages --editable='.[extras]'
- name: Install project (Windows)
if: runner.os == 'Windows'
run: |
pip3 install --requirement=requirements-test.txt
pip3 install --editable=.
pip3 install --editable='.[extras]'
- name: Run tests
env:
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python: "3.12"
apt_packages:
- libeccodes-dev
- libgeos-dev
Expand Down
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,9 @@ conda activate herbie
Alternatively, Herbie is published on PyPI and you can install it with pip, _but_ it requires some dependencies that you will have to install yourself:

- Python 3.9+
- cURL
- [cfgrib](https://github.com/ecmwf/cfgrib), which requires eccodes.
- _Optional:_ wgrib2
- _Optional:_ [Carpenter Workshop](https://github.com/blaylockbk/Carpenter_Workshop)
- [cURL](https://anaconda.org/conda-forge/curl)
- [eccodes](https://anaconda.org/conda-forge/eccodes), a requirement for [cfgrib](https://github.com/ecmwf/cfgrib).
- _Optional:_ [wgrib2](https://anaconda.org/conda-forge/wgrib2)

When those are installed within your environment, _then_ you can install Herbie with pip.

Expand All @@ -90,6 +89,9 @@ pip install herbie-data

# Most recent changes
pip install git+https://github.com/blaylockbk/Herbie.git

# Dependecies for extra features
pip install herbie-data[extra]
```

## Capabilities
Expand Down Expand Up @@ -160,16 +162,16 @@ Herbie downloads model data from the following sources, but can be extended to i

## Community

Having trouble using Herbie or have a question? [💬 GitHub Discussions/Ask For Help](https://github.com/blaylockbk/Herbie/discussions/categories/q-a)
Having trouble using Herbie or have a question? [ GitHub Discussions/Ask For Help](https://github.com/blaylockbk/Herbie/discussions/categories/q-a)

Just want to talk about Herbie or have an idea? [🗣️ GitHub Discussions](https://github.com/blaylockbk/Herbie/discussions/categories)
Just want to talk about Herbie or have an idea? [💬 GitHub Discussions](https://github.com/blaylockbk/Herbie/discussions/categories)

See something that might be wrong? [🚑 GitHub Issues](https://github.com/blaylockbk/Herbie/issues)

Want to contribute? Great! I'd love your help.

- "Watch" this repo's discussions and issues.
- Participate in [🗣️ GitHub Discussions](https://github.com/blaylockbk/Herbie/discussions/categories) and answer questions.
- Participate in [💬 GitHub Discussions](https://github.com/blaylockbk/Herbie/discussions/categories) and answer questions.
- Share how you use Herbie in [🙌 GitHub Discussions/Show and tell](https://github.com/blaylockbk/Herbie/discussions/categories/show-and-tell)
- Open an issue or file a pull request to make Herbie even better!
- Contribute to documentation.
Expand Down Expand Up @@ -204,9 +206,9 @@ Herbie was then developed to access HRRR data from that archive and was first us
<p style="padding-left: 22px ; text-indent: -22px ;"> Blaylock, B. K., J. D. Horel, and C. Galli, 2018: High-Resolution Rapid Refresh Model Data Analytics Derived on the Open Science Grid to Assist Wildland Fire Weather Assessment. J. Atmos. Oceanic Technol., 35, 2213–2227, <a href="https://doi.org/10.1175/JTECH-D-18-0073.1">https://doi.org/10.1175/JTECH-D-18-0073.1</a>.</p>
</cite></blockquote>

In the later half of 2020, the HRRR dataset from 2014 to present was made available through the [NODD Program](https://www.noaa.gov/information-technology/open-data-dissemination) (formerly NOAA's Big Data Program). The latest version of Herbie organizes and expands my original download scripts into a more coherent package with the extended ability to download data for other models from many different archive sources.
In the later half of 2020, the HRRR dataset from 2014 to present was made available through the [NODD Open Data Dissemination Program](https://www.noaa.gov/information-technology/open-data-dissemination) (formerly NOAA's Big Data Program). The latest version of Herbie organizes and expands my original download scripts into a more coherent package with the extended ability to download data for other models from many different archive sources, and it will continues to evolve.

I originally released this package under the name “HRRR-B” because it only worked with the HRRR dataset; the “B” was for my first-name initial. Since then, I have added the ability to download RAP, GFS, ECMWF, GEFS, RRFS, and others with potentially more models in the future. Thus, this package was renamed **_Herbie_**, named after one of my favorite childhood movie characters.
I originally released this package under the name “HRRR-B” because it only worked with the HRRR dataset; the “B” was for Brian. Since then, I have added the ability to download many more models including RAP, GFS, ECMWF, GEFS, and RRFS with the potential to add more models in the future. Thus, this package was renamed **_Herbie_**, named after one of my favorite childhood movies.

The University of Utah MesoWest group now manages a [HRRR archive in Zarr format](http://hrrr.chpc.utah.edu/). Maybe someday, Herbie will be able to take advantage of that archive.

Expand All @@ -229,4 +231,4 @@ P.S. If you like Herbie, check out my other repos:
> **Note**: Alternative Download Tools
> As an alternative to Herbie, you can use [rclone](https://rclone.org/) to download files from AWS or GCP. I love rclone. Here is a short [rclone tutorial](https://github.com/blaylockbk/pyBKB_v3/blob/master/rclone_howto.md)
| [Visualize Structure](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=blaylockbk%2FHerbie) | [Star History](https://star-history.com/#blaylockbk/Herbie&Date)
| [Visualize Structure](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=blaylockbk%2FHerbie) | [Star History](https://star-history.com/#blaylockbk/Herbie&Date) | [PyPI Download Statistics](https://pypistats.org/packages/herbie-data)
Binary file added docs/_static/paint/AirQualityIndex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/AirQualityIndex_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Herbie.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Herbie_Colors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Herbie_Colors_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Herbie_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Land_Sequential.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Land_Sequential_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWSTemperature_kwargs2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWS_Continuous.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWS_Continuous_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWS_Qualitative.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWS_Qualitative_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWS_Sequential.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/NWS_Sequential_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Radar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/Radar_lightness.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/herbie_paint_landGreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/herbie_paint_nws.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/paint/herbie_paint_nwsTmp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/api_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ Docstring reference for the ``herbie`` module
accessors
fast
latest
paint
wgrib2
misc
35 changes: 35 additions & 0 deletions docs/api_reference/paint.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
=============
herbie.paint
=============

.. toctree::
:maxdepth: 2

.. currentmodule:: herbie.paint

.. autosummary::
:toctree: _autosummary

NWSTemperature
NWSWindChill
NWSHeatIndex
NWSDewPointTemperature
NWSRelativeHumidity
NWSWindSpeed
NWSCloudCover
NWSProbabilityOfPrecipitation
NWSProbabilityOfPrecipitationSnow
NWSProbabilityOfPrecipitationIce
NWSPrecipitation
NWSPrecipitationSnow
NWSPrecipitationIce
NWSWaveHeight
LandTan
LandBrown
LandGreen
Water
HerbieWhite
HerbieTan
HerbieBlack


10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
#
import os
import sys
from datetime import datetime
import datetime

import pydata_sphinx_theme

import herbie # # Required to get herbie version and to for accessors to be documented
import herbie # Required to get herbie version and to for accessors to be documented

sys.path.insert(0, os.path.abspath("../.."))

Expand All @@ -28,11 +28,11 @@


# ---- Project information -----------------------------------------------------
utc_now = datetime.utcnow().strftime("%H:%M UTC %d %b %Y")
utc_now = datetime.datetime.now(datetime.UTC).strftime("%H:%M UTC %d %b %Y")

project = "Herbie"
copyright = f"{datetime.utcnow():%Y}, Brian K. Blaylock. ♻ Updated: {utc_now}"
author = f"Brian K. Blaylock"
author = "Brian K. Blaylock"
copyright = f"{datetime.datetime.now(datetime.UTC).strftime('%Y')}, {author}. ♻ Updated: {utc_now}"


# ---- General configuration ---------------------------------------------------
Expand Down
27 changes: 27 additions & 0 deletions docs/fix_notebook.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
"""Fix jupyter notebooks when they have issues.
I've had to use this on my notebooks to fix them after doing find/replace
operations, and other weird things that happen.
"""

import nbformat
from pathlib import Path


for FILE in sorted(Path("./").rglob("*.ipynb")):
print(FILE)
with open(FILE, "r") as file:
nb_corrupted = nbformat.reader.read(file)

nbformat.validator.validate(nb_corrupted)
# <stdin>:1: MissingIDFieldWarning: Code cell is missing an id field,
# this will become a hard error in future nbformat versions.
# You may want to use `normalize()` on your notebooks before validations (available since nbformat 5.1.4).
# Previous versions of nbformat are fixing this issue transparently, and will stop doing so in the future.

nb_fixed = nbformat.validator.normalize(nb_corrupted)
nbformat.validator.validate(nb_fixed[1])
# Produces no warnings or errors.

with open(FILE, "w") as file:
nbformat.write(nb_fixed[1], file)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"outputs": [],
"source": [
"from herbie import Herbie\n",
"from toolbox import EasyMap, pc"
"from herbie.toolbox import EasyMap, pc"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,7 @@
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.2"
},
"orig_nbformat": 4
}
},
"nbformat": 4,
"nbformat_minor": 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1451,7 +1451,6 @@
"pygments_lexer": "ipython3",
"version": "3.10.8"
},
"orig_nbformat": 4,
"vscode": {
"interpreter": {
"hash": "ac511961bc6976a3d289cde8fc247e6b0e9298cf513cb762aa0a7df646d192ed"
Expand Down
Loading

0 comments on commit 43da859

Please sign in to comment.