Skip to content

docs: clarify Hodges API wording #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mwyau merged 1 commit into from
Aug 27, 2026
Merged

docs: clarify Hodges API wording #205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/hodges.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,11 @@ coefficients and performs repeated evaluation and optimization in NumPy/Numba.
The mathematical spline lineage is Dierckx/FITPACK; the numerical interface is
provided by SciPy.

`track_smoopy_optimization_scale` is a public numerical optimizer parameter. Its
normal default is `1.0`; the historical TRACK-compatible validation setting is
`0.01`. It does not rescale stored fields or detection thresholds. TRACK's line
search is not invariant to this numerical scaling.
`HodgesTracker(track_smoopy_optimization_scale=...)` controls numerical scaling
in the rectangular GDFP optimizer. Its normal default is `1.0`; the historical
TRACK-compatible validation setting is `0.01`. It does not rescale stored fields
or detection thresholds. TRACK's line search is not invariant to this numerical
scaling.

The rectangular source-compatible path also preserves several non-obvious
`non_lin_opt()` semantics: a failed optimization retains the original grid
Expand Down Expand Up @@ -310,8 +311,9 @@ The resolution helpers in `pystormtracker.backends` own these defaults.
Serial and MPI execution do not use Dask frame or MGE worker pools, so explicit
`frame_workers` and `mge_workers` values are rejected there. Explicit
`sht_threads` remains meaningful for serial SHT and for rank-local MPI SHT.
The former Hodges `workers` parameter was removed in this development API;
SimpleTracker and HealpixTracker retain their generic `workers` controls.
`HodgesTracker` no longer accepts `workers`; use `frame_workers`, `sht_threads`,
and `mge_workers`. `SimpleTracker` and `HealpixTracker` continue to accept
`workers`.

The current SHT implementation uses DUCC0. PyStormTracker passes the resolved
`sht_threads` as DUCC0's `nthreads` argument to regular, reduced-grid, and
Expand Down Expand Up @@ -600,4 +602,4 @@ All links target the immutable `TRACK-1.5.4` tag.
- **Wang, X. L., V. R. Swail, and F. W. Zwiers**, 2006: Climatology and
Changes of Extratropical Cyclone Activity: Comparison of ERA-40 with
NCEP-NCAR Reanalysis for 1958-2001. *J. Climate*, **19**, 3145–3166.
[doi:10.1175/JCLI3781.1](https://doi.org/10.1175/JCLI3781.1).
[doi:10.1175/JCLI3781.1](https://doi.org/10.1175/JCLI3781.1).