SlideRuleEarth / sliderule

Server and client framework for on-demand science data processing in the cloud
https://slideruleearth.io
Other
27 stars 12 forks source link

Doc improvement suggestions, mostly Raster #372

Open dshean opened 8 months ago

dshean commented 8 months ago

Just reviewing, https://slideruleearth.io/web/rtd/user_guide/GeoRaster.html and jotting down some notes for discussion and potential improvement.

First of all, Is there a reason this section is called is "GeoRaster" instead of "Raster support"?

The Asset directory on the raster page includes both point cloud and raster sources. I think this table should only include raster datasets, or should point to a more centralized table. We have a separate table here: https://slideruleearth.io/web/rtd/user_guide/SlideRule.html#assets.

Also, some links to external data sources from the table would be useful, so users could read more about what they're sampling. Though this does require more maintenace to avoid dead links.

The sampling doc (including the example) could use some review. We might show a more generic form for the sampling request with appropriate syntax highlight to show required vs. optional user input...

"samples" : {
"output_column_name1": {"asset": "[asset_name_from_table]", [sampling_parameters]}, 
"output_column_name2": {"asset": "[asset_name_from_table]", [sampling_parameters]},
...}

Is there a reason the raster sampling parameters are split off in the core module doc? https://slideruleearth.io/web/rtd/user_guide/SlideRule.html#raster-sampling. This Sampling Parameters should at least have a section header here, so users don't miss it.

I wonder if it might make sense for us to define a default output column name and default sampling parameters for each asset (based on expected science use case for each dataset), so new users could just specify the desired asset to sample and get results.

It would be useful to have a dedicated subsection of the Raster doc for the ArcticDEM/REMA products, like HLS section, explaining nuances of mosaic vs. strips and what to expect. I think several of the raster datasets listed in the asset table require some notes (and potentially recommended/default sampling parameters), so maybe we just have a section toward the end of the Raster doc for "Notes for Specific Raster Assets" or something with subheadings for each dataset, instead of "Special Case"

Also, I'm not sure GeoParquet deserves a top-level section in our User's guide. This could go under a more generic "Supported Formats" section or something. This is in line with discussion of our last call around recommendations for reproducibility and documenting I/O options.