Lacking documentation for MeteoLowFreq #843

Activity

1. lior-antonov

   assigned

   yehudarav

   on Apr 26, 2026
2. lior-antonov

   assigned

   ilayfalach

   and unassigned

   yehudarav

   on May 12, 2026
3. ilayfalach commented on Sep 15, 2026

   

   ilayfalach

   on Sep 15, 2026

   Collaborator

   More actions

   Rewritten on local branch ISSUE843 (commits d2ab600a, 1474e02d).

   Checked every name on the page against hera/measurements/meteorology/lowfreqdata/. Four things were wrong:

   • plotSeasonalHourly does not exist anywhere in the package.
   • calcHourlyDist takes Field (capital F) and normalization, not field and density.
   • plotProbContourf_bySeason takes plotField, a single column name, not fields=[...].
   • dateLinePlot, plotProbContourf and resampleSecondMoments were not documented at all.

   The page now follows the structure of the sibling MeteoHighFreq page: data source format and docType, initialisation, all three analysis methods (with the exact columns addDatesColumns adds and the three valid normalization values), and all four plotting methods grouped by the dailyPlots / seasonalPlots accessor they hang off. It also records that the toolkit constant MeteoLowFreq and the database toolkit name lowFreqMeteorology differ, which the old page did not mention.

   hera/tests/unit/test_lowfreq_docs_match_code.py parses the Python examples out of the page and resolves every lf.<accessor>.<method>(...) call and keyword argument against the real classes, so this cannot drift again silently. Against the old page it fails with exactly the four errors above.

   Separate commit, unrelated to the docs: presenation.__init__, Plots.__init__, SeasonalPlots.__init__ and DailyPlots.__init__ each printed emoji debug lines, so every getToolkit(METEOROLOGY_LOWFREQ) wrote seven lines to stdout. Removed.
4. ilayfalach commented on Sep 15, 2026

   

   ilayfalach

   on Sep 15, 2026

   Collaborator

   More actions

   PR #1078 opened.
5. lior-antonov

   added a commit that references this issue on Sep 23, 2026

   Merge pull request #1078 from KaplanOpenSource/ISSUE843

   ...

   78e77d3
6. lior-antonov

   closed this as completedin #1078on Sep 23, 2026