search

SlideRuleEarth / sliderule-python

SlideRule Earth Example Notebooks: On-demand, cloud-based processing of satellite mission data (NASA ICESat-2, GEDI, ArcticDEM/REMA, HLS)
https://slideruleearth.io/rtd/
BSD 3-Clause "New" or "Revised" License
41 stars 21 forks source link

Add screenshots or figures to README and doc #15

Closed dshean closed 3 years ago

dshean commented 3 years ago

In trying to explain SlideRule to others, even those familiar with ICESat-2 and product types, it's still not easy to understand "what does SlideRule do?"

A figure could go a long way on README and doc. Maybe two panels, with map on left showing query polygon and all returned pionts, then profile on right with ATL03 points, ATL06 points and ATL06-SR points generated using different parameters.

Might also be good to include one of @jpswinski diagrams showing general infrastructure and configuration, but that might better on the sliderule repo.

jpswinski commented 3 years ago

@dshean I wonder if a landing page isn't in greater need than I expected. If we put a simple static site at icesat2sliderule.org then we could do everything you've described and make it very tailored to the ICESat-2 deployment of SlideRule and our potential users.

dshean commented 3 years ago

If it's not to much trouble to stand that up, I think it would be useful. The README and doc for individual repos can work as a placeholder, but some top-level landing page for the Org/project would be good, so we can explain the different components, route users appropriately, and generally improve our credibility.

Should probably create a separate repo to store site content with version control and potentially automated deployment. Most of my recent experience is with GH pages, which works well. Open to whatever people think is easiest. Fine to start with simple static html with basic info at this point.

I still think one or two simple figures are important for visual communication of high-level "what is sliderule?", and to show off what SlideRule can do. Assume we have 10 seconds to convince a user that SlideRule is worth their time. Personally, a good overview summary and highlight figure draws me in when I'm making a decision about whether to try out a new package. Could be as simple as saving output figure(s) from one of the example notebooks and including as a separate jpg/png on landing page.

jpswinski commented 3 years ago

This has been fulfilled via the website at http://icesat2sliderule.org and the "Overview" page which provides diagrams and descriptions of what SlideRule does at a high level.