From c59837cec0ce47bf7331e4512512eb5aca658cb8 Mon Sep 17 00:00:00 2001 From: Sharon Fitzpatrick Date: Fri, 6 Sep 2024 15:55:16 -0700 Subject: [PATCH] add disclaimer about coastseg working on sand beaches --- docs/getting-started.md | 22 +++++++++++++++++----- docs/index.md | 2 ++ 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 5c8cecd3..e86c13d0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,3 +1,7 @@ +# Getting Started + +CoastSeg works best on sand and gravel beaches. It is not as effective at other sites or a marsh beaches. + ## Prerequisites **1.Sign up to use Google Earth Engine Python API** @@ -73,6 +77,14 @@ conda activate coastseg jupyter lab SDS_coastsat_classifier.ipynb ``` +- If this doesn't work then try entering the full path to the notebook + + -- If you notebook is at `C:\projects\CoastSeg` then you would enter the path `C:\projects\CoastSeg\SDS_coastsat_classifier.ipynb` + +```bash +jupyter lab C:\projects\CoastSeg\SDS_coastsat_classifier.ipynb +``` + ![jupyter notebbok open classifier](https://github.com/user-attachments/assets/ed1dddb2-3a01-4572-b2c1-4cc0ff794972) @@ -98,7 +110,9 @@ jupyter lab SDS_coastsat_classifier.ipynb **4.Draw an Bounding Box** -- Draw a bounding box along the coast in this box is where ROIs will be created +- Draw a bounding box along the coast in this box is where ROIs will be created. + +- You can only draw bounding boxes along the coast to generate ROIs this is because CoastSeg is only designed to extract shorelines. **Option 1: Draw a Bounding Box with the box tool** @@ -120,6 +134,8 @@ jupyter lab SDS_coastsat_classifier.ipynb **6.Load Transects** +- Not all locations in the world have transects or shorelines available. Feel free to submit an issue to contribute transects or shorelines. + - Make sure there are transects inside the ROI you have selected otherwise you won't be able to extract shorelines - If there isn't a reference shoreline or any transects available for your site check out the guide on how to upload your own [here](https://satelliteshorelines.github.io/CoastSeg/how-to-upload-features/) @@ -132,8 +148,6 @@ jupyter lab SDS_coastsat_classifier.ipynb - Change the dates to 12/01/2023 - 03/01/2024 -- Change the size of the reference shoreline buffer - - Click `Save Settings` ![save_settings_getting_started_circle](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/c14c2e01-bb1f-43d2-b932-b0ccfb82a598) @@ -174,8 +188,6 @@ jupyter lab SDS_coastsat_classifier.ipynb ![case_study_1_download_roi](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/1a30f9c7-fc4d-4e34-a57b-055624ff8464) - - **11.Extract Shorelines** ![save_settings_download_extract](https://github.com/Doodleverse/CoastSeg/assets/61564689/3548a9ce-a190-4c95-b495-0ff75484fdb2) diff --git a/docs/index.md b/docs/index.md index 7c939fe4..30ac03f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,6 +22,8 @@ Check out the [CoastSeg YouTube Channel](https://www.youtube.com/@CoastSeg-n3e/v ## Getting Started +CoastSeg works best on sand and gravel beaches. It is not as effective at other sites or a marsh beaches. + Please see [Getting Started guide](https://satelliteshorelines.github.io/CoastSeg/getting-started/), which includes instructions for - Pre-requisites (accounts, data access)