search

Unidata / thredds

THREDDS Data Server v4.6
https://www.unidata.ucar.edu/software/tds/v4.6/index.html
265 stars 179 forks source link

Improve docs and tests for "tiled" and FMRC aggregations #785

Open cwardgar opened 7 years ago

cwardgar commented 7 years ago

From #778.

tiled aggregations are only mentioned very briefly in two places in AnnotatedSchema4.adoc. They're also mentioned in the NcML reference document, but that thing's obviously an unfinished stub (we should probably nuke it). There are no examples for them in the docs, but there is a test.

FMRC aggregations are listed in 6 separate reference docs: Aggregation.adoc, AnnotatedSchema4.adoc, Formica.adoc, the NcML reference document, Fmrc.adoc, and FmrcCollection.adoc. Unfortunately, there's a lot of cruft and duplication in there. For example, the aggregation type forecastModelRunSingleCollection is hardly mentioned at all. Why?

cofinoa commented 7 years ago

yes, my experience with TiledAggregation started when I discovered it reading the code for the aggregation. That could be the reason, is scarced mentioned in the doc, I was asking about it in th email list. I'm still have to make many try & error and "readthecode" everytme I'm using it.

The FMRC collection agregations are time oriented ones (forecastModelRuntime and/or forecastTime) but tiled aggregation is the general case for them and for outer dimension aggregation. It worth it to mantain the test and improve the doc with more examples.