Doc tree specifically for 'data' and 'sessions'

SatelliteShorelines / CoastSeg

An interactive toolbox for downloading satellite imagery, applying image segmentation models, mapping shoreline positions and more. The mapping extension for CoastSat and Zoo.

https://satelliteshorelines.github.io/CoastSeg/

GNU General Public License v3.0

49 stars 10 forks source link

Doc tree specifically for 'data' and 'sessions' #260

Closed fmemuir closed 5 months ago

fmemuir commented 5 months ago

For review 6683

Small suggestion for the wiki, to make it clearer on the filing structure of where imagery and outputs are stored. The 'data' folder is mentioned in the Tutorials and Case Studies when bad images are filtered out, but it is only clear from the screenshots where the RGB folder of imagery sits and that this is the one to filter images out of. Additionally, the difference between 'data' and the output data stored in 'sessions' could be clearer; it's not immediately obvious that the extracted data is here. It's recommended that the wiki is given a short explanation (or even just a document tree fig) of where different files are being stored when the shorelines are extracted.

2320sharon commented 5 months ago

Hi @fmemuir

Thank you for the suggestions. These are excellent ideas. I'll update the wiki pages to explain why the downloaded imagery and sessions are separated and where the outputs go when the shoreline extraction process occurs. This should make the idea of using sessions easier for new users and help them understand where their data is stored.

Tasks

[x] Explain the difference between 'data' and sessions in the Getting Started, Case Studies and How to use Sessions guides in the wiki
[x] Add a doctree to explain the file structure of a session to How to use Sessions and How to Extract Shorelines guides
[x] Explain how the downloaded data from 'data' is used in a session in the Getting Started, Case Studies and How to use Sessions guides in the wiki
[x] Add a doctree to the How to Filter Bad Imagery and link to this guide in case_study_2

Please let me know if this works or if there are any additional changes you suggest.

2320sharon commented 5 months ago

@fmemuir

I have implemented your feedback and made several enhancements to the documentation as detailed below:

Screenshot Addition to Getting Started Guide: I've included a screenshot in the getting started guide to help users locate the RGB imagery for sorting.
I updated the Getting Started Guide to clarify the difference between the ROIs in CoastSeg/data and CoastSeg/sessions and added a screenshot to show users where to find the shoreline detection images here
I updated the How to Filter Bad Imagery and link to this guide in case_study_2
I updated the How to Use Sessions guide to tell the user where the sessions are saved as well as how each session is related to ROIs in CoastSeg/data
I also added a new page to the website called What is in a Session that breaks down each kind of file in a session and includes a doctree of the session contents.

Thank you for your feedback and I hope this will make sessions easier to understand. Please let me know if these changes work or if there needs to be any additional clarification.

Thank you again for reviewing CoastSeg and for your helpful feedback.

fmemuir commented 5 months ago

@2320sharon Great updates, really appreciate the added clarification!