hefty 0.2.1__tar.gz → 0.3.1__tar.gz

{hefty-0.2.1/src/hefty.egg-info → hefty-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hefty
-Version: 0.2.1
+Version: 0.3.1
 Summary: Some (relatively) lightweight short-term energy forecasting tools for solar, wind, and load.
 Author: Will Hobbs
 License-Expression: BSD-3-Clause
@@ -14,8 +14,8 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: herbie-data[scikit-learn]>=2026.3.0
-Requires-Dist: pvlib>=0.13.1
+Requires-Dist: herbie-data[scikit-learn]>=2026.9.2
+Requires-Dist: pvlib>=0.16.1
 Requires-Dist: pandas>=3.0.0
 Requires-Dist: urllib3>=2.6.0
 Dynamic: license-file
@@ -132,6 +132,7 @@ The [examples](examples) folder contains several example Jupyter notebooks.
 - [ensemble_example.ipynb](examples/ensemble_example.ipynb): Examples of multi-member ensembles with IFS, AIFS, and GEFS.
 - [wind_example.ipynb](examples/wind_example.ipynb): A basic wind resource forecast example using a few models, including converting the data to a format compatible with `windpowerlib`*.
 - [erbs_vs_dirindex.ipynb](examples/erbs_vs_dirindex.ipynb): A comparison of Erbs and DIRINDEX irradiance decomposition models using SURFRAD measurements.
+- [dynamical_example.ipynb](examples\dynamical_example.ipynb): Examples using [dynamical.org](https://dynamical.org) as a data source (`priority`), which can be about 10X faster than other options, but with just a few limitations. 
 
 \* https://github.com/wind-python/windpowerlib/
 
@@ -144,6 +145,8 @@ fit inside the listed span for the selected cycle. Use
 `adjust_forecast_datetimes()` to select an initialization time and lead-time
 combination that satisfies cycle-specific limits. Note that these forecast model schedules/features can change over time, and the `get_fcast_definition` function in `hefty.utilities` is intended to record these changes.
 
+>Note that [dynamical.org](https://dynamical.org) (when using `priority='dynamical'`) does not currently have all initialization times and historical data for all models, and `get_fcast_definition` and `adjust_forecast_datetimes()` do not yet account for this. See [dynamical_example.ipynb](examples/dynamical_example.ipynb), the table in [Issue #64](https://github.com/williamhobbs/hefty/issues/64#issuecomment-4939703931), and https://dynamical.org/catalog/ for more info.
+
 | Model | Forecast type | Function support | Cycles | Available forecast span | Forecast-hour steps |
 | --- | --- | --- | --- | --- | --- |
 | `hrrr` | NOAA HRRR deterministic NWP | Solar, wind | Hourly; `00z`, `06z`, `12z`, and `18z` have extended range | `0`-`18` h; extended cycles: `0`-`48` h | 1 h |
@@ -220,7 +223,7 @@ Those outputs could then be directly passed as inputs to `hefty.solar.get_solar_
 
 Model delays are more than just a fixed time: they can vary by lead time and by cycle time. And some cycles have different total run lengths and interval size for some models. `adjust_forecast_datetimes` adjusts for all of this for you.
 
-Delays calculated in `adjust_forecast_datetimes` are based on experiments in this gist https://gist.github.com/williamhobbs/9585ff5d1248ab5de4d9e8665d7c8ea6 (which will hopefully one day be cleaned up and added to this repo somehow), documentation published by ECMWF, and this cool dashboard by dynamical.org https://dynamical.org/status/.
+Delays calculated in `adjust_forecast_datetimes` are based on experiments in this notebook [docs/forecast_model_delays.ipynb](docs/forecast_model_delays.ipynb) (or see this markdown version, [docs/forecast_model_delays.md](docs/forecast_model_delays.md)), documentation published by ECMWF, and this cool dashboard by dynamical.org https://dynamical.org/status/.
 
 ## Local disk space
 The current version of hefty keeps copies of downloaded grib files on your local storage. This can result in a large amount of disk space being used up. Future versions of hefty may change this (see [issue #70](https://github.com/williamhobbs/hefty/issues/70)), but for now, users may need to monitor storage space and manually delete files if needed. 

{hefty-0.2.1 → hefty-0.3.1}/README.md

@@ -110,6 +110,7 @@ The [examples](examples) folder contains several example Jupyter notebooks.
 - [ensemble_example.ipynb](examples/ensemble_example.ipynb): Examples of multi-member ensembles with IFS, AIFS, and GEFS.
 - [wind_example.ipynb](examples/wind_example.ipynb): A basic wind resource forecast example using a few models, including converting the data to a format compatible with `windpowerlib`*.
 - [erbs_vs_dirindex.ipynb](examples/erbs_vs_dirindex.ipynb): A comparison of Erbs and DIRINDEX irradiance decomposition models using SURFRAD measurements.
+- [dynamical_example.ipynb](examples\dynamical_example.ipynb): Examples using [dynamical.org](https://dynamical.org) as a data source (`priority`), which can be about 10X faster than other options, but with just a few limitations. 
 
 \* https://github.com/wind-python/windpowerlib/
 
@@ -122,6 +123,8 @@ fit inside the listed span for the selected cycle. Use
 `adjust_forecast_datetimes()` to select an initialization time and lead-time
 combination that satisfies cycle-specific limits. Note that these forecast model schedules/features can change over time, and the `get_fcast_definition` function in `hefty.utilities` is intended to record these changes.
 
+>Note that [dynamical.org](https://dynamical.org) (when using `priority='dynamical'`) does not currently have all initialization times and historical data for all models, and `get_fcast_definition` and `adjust_forecast_datetimes()` do not yet account for this. See [dynamical_example.ipynb](examples/dynamical_example.ipynb), the table in [Issue #64](https://github.com/williamhobbs/hefty/issues/64#issuecomment-4939703931), and https://dynamical.org/catalog/ for more info.
+
 | Model | Forecast type | Function support | Cycles | Available forecast span | Forecast-hour steps |
 | --- | --- | --- | --- | --- | --- |
 | `hrrr` | NOAA HRRR deterministic NWP | Solar, wind | Hourly; `00z`, `06z`, `12z`, and `18z` have extended range | `0`-`18` h; extended cycles: `0`-`48` h | 1 h |
@@ -198,7 +201,7 @@ Those outputs could then be directly passed as inputs to `hefty.solar.get_solar_
 
 Model delays are more than just a fixed time: they can vary by lead time and by cycle time. And some cycles have different total run lengths and interval size for some models. `adjust_forecast_datetimes` adjusts for all of this for you.
 
-Delays calculated in `adjust_forecast_datetimes` are based on experiments in this gist https://gist.github.com/williamhobbs/9585ff5d1248ab5de4d9e8665d7c8ea6 (which will hopefully one day be cleaned up and added to this repo somehow), documentation published by ECMWF, and this cool dashboard by dynamical.org https://dynamical.org/status/.
+Delays calculated in `adjust_forecast_datetimes` are based on experiments in this notebook [docs/forecast_model_delays.ipynb](docs/forecast_model_delays.ipynb) (or see this markdown version, [docs/forecast_model_delays.md](docs/forecast_model_delays.md)), documentation published by ECMWF, and this cool dashboard by dynamical.org https://dynamical.org/status/.
 
 ## Local disk space
 The current version of hefty keeps copies of downloaded grib files on your local storage. This can result in a large amount of disk space being used up. Future versions of hefty may change this (see [issue #70](https://github.com/williamhobbs/hefty/issues/70)), but for now, users may need to monitor storage space and manually delete files if needed. 

{hefty-0.2.1 → hefty-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hefty"
-version = "0.2.1"
+version = "0.3.1"
 description = "Some (relatively) lightweight short-term energy forecasting tools for solar, wind, and load."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -19,8 +19,8 @@ classifiers = [
     "Topic :: Scientific/Engineering",
 ]
 dependencies = [
-    "herbie-data[scikit-learn] >= 2026.3.0",
-    "pvlib >= 0.13.1",
+    "herbie-data[scikit-learn] >= 2026.9.2",
+    "pvlib >= 0.16.1",
     "pandas >= 3.0.0",
     "urllib3 >= 2.6.0",
 ]

{hefty-0.2.1 → hefty-0.3.1}/src/hefty/custom.py

@@ -9,7 +9,7 @@ def get_custom_forecast(latitude, longitude, init_date, run_length,
                         lead_time_to_start=0, period=3, model='gfs',
                         product='pgrb2.0p25', search_str=':TMP:2 m above',
                         member='avg', attempts=2, hrrr_hour_middle=True,
-                        hrrr_coursen_window=None, priority=None):
+                        hrrr_coarsen_window=None, priority=None):
     """
     Get a custom forecast for one or several sites from one of several
     NWPs. This function uses Herbie [1]_.
@@ -63,7 +63,7 @@ def get_custom_forecast(latitude, longitude, init_date, run_length,
         integrated hourly forecast that is centered in the middle of the
         hour.
 
-    hrrr_coursen_window : int or None, default None
+    hrrr_coarsen_window : int or None, default None
         If model is 'hrrr', optional setting that is the x and y window size
         for coarsening the xarray dataset, effectively applying spatial
         smoothing to the HRRR model. The HRRR has a native resolution of
@@ -145,9 +145,9 @@ def get_custom_forecast(latitude, longitude, init_date, run_length,
         # calculate wind speed from u and v components
         ds = ds.herbie.with_wind('both')
 
-        if model == 'hrrr' and hrrr_coursen_window is not None:
-            ds = ds.coarsen(x=hrrr_coursen_window,
-                            y=hrrr_coursen_window,
+        if model == 'hrrr' and hrrr_coarsen_window is not None:
+            ds = ds.coarsen(x=hrrr_coarsen_window,
+                            y=hrrr_coarsen_window,
                             boundary='trim').mean()
 
         # use pick_points for single point or list of points