update getting started guide with more screenshots + add jupyter note…

…book guide

docs/getting-started.md

@@ -24,7 +24,7 @@
 **1.Activate the coastseg conda environment**
 
 - Open anaconda prompt.
-- Make sure you installed coastseg if not follow the installation guide : [basic install guide](https://satelliteshorelines.github.io/CoastSeg/basic-install-guide/)
+- Make sure you have coastseg installed if not follow the installation guide : [basic install guide](https://satelliteshorelines.github.io/CoastSeg/basic-install-guide/)
 
 ```bash
 conda activate coastseg
@@ -41,7 +41,7 @@ conda activate coastseg
 
 - Open 'git bash' (use this in the search bar on windows) and open the app. 
 
-- Here is an example below where I have installed CoastSeg in a folder called 'projects'. 
+- Here is an example below where I have installed CoastSeg in a folder called 'projects', but you can install it wherever you'd like just make sure to remember the location.
 
 - After the download finishes close git bash.
 
@@ -72,13 +72,34 @@ conda activate coastseg
 jupyter lab SDS_coastsat_classifier.ipynb
 ```
 
+- Enter 'jupyter lab SDS_coastsat_classifier.ipynb' in anaconda prompt and your notebook should automatically open in the browser
+
+- PLEASE MAKE SURE YOU RUN THIS IN THE COASTSEG DIRECTORY WHERE THE NOTEBOOK `SDS_coastsat_classifier.ipynb` IS LOCATED
+
+![jupyter notebbok open classifier](https://github.com/user-attachments/assets/ed1dddb2-3a01-4572-b2c1-4cc0ff794972)
+
+
 **2.Authenticate with Google Earth Engine**
 
 - Run the cell located under 'Authenticate with Google Earth Engine (GEE)'
 
-![auth_cell_cropped](https://github.com/Doodleverse/CoastSeg/assets/61564689/642c8353-bfab-4458-a248-a8efce01f1ee)
+![run_cell](https://github.com/user-attachments/assets/6bb955a7-edb3-4445-9337-d20d4bb95976)
+
+
+**3.Run the Cell 'Create Coastseg Map Dashboard'**
+
+- Run the cell to create the map dashboard
+
+
+![run map dashboard](https://github.com/user-attachments/assets/fe46dcf3-352b-458e-a261-f2adbd4663f5)
+
+- After you run the cell you should see the UI appear
+
+- Scroll down to the interactive map
+
+![ran map dashboard](https://github.com/user-attachments/assets/ddd44c63-9285-42a6-a69c-c7410d09a29c)
 
-**3.Draw an Bounding Box**
+**4.Draw an Bounding Box**
 
 - Draw a bounding box along the coast in this box is where ROIs will be created
 
@@ -92,23 +113,23 @@ jupyter lab SDS_coastsat_classifier.ipynb
 
 ![draw_bbox_polygon_remove_back_barrier](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/a63f023a-f9a8-4e48-9aca-bfa00dc262ea)
 
-**4.Generate ROI (Region of Interest)**
+**5.Generate ROI (Region of Interest)**
 
 - ROIs can only be generated along a shoreline
 
 - If no shoreline is found then an error message will appear telling you no ROIs can be created. If this happens create your own reference shoreline following the guide here [How to Create Reference Shoreline](https://satelliteshorelines.github.io/CoastSeg/How-to-Create-Reference-Shorelines-%26-Transects%26ROIs/)
 
 ![generate_roi](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/ade2123f-3ea6-4dc0-ac5b-15f5f758e220)
 
-**5.Load Transects**
+**6.Load Transects**
 
 - 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/)
 
 ![load_rois_then_transects_on_map_demo](https://github.com/Doodleverse/CoastSeg/assets/61564689/d53154b0-7a63-470f-91ec-dabdf7d4a100)
 
-**6.Modify the Settings**
+**7.Modify the Settings**
 
 - Change the satellites to L8 and L9
 
@@ -120,7 +141,7 @@ jupyter lab SDS_coastsat_classifier.ipynb
 
 ![save_settings_getting_started_circle](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/c14c2e01-bb1f-43d2-b932-b0ccfb82a598)
 
-**7.Name the Session**
+**8.Name the Session**
 
 - Name the session 'demo_session'. This will be the name of the folder saved in `CoastSeg/sessions`.
 
@@ -131,15 +152,15 @@ jupyter lab SDS_coastsat_classifier.ipynb
 
 ![save_demo_session](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/4340c734-e20d-4149-89c2-11e73d9905d3)
 
-**8.Preview the available Imagery**
+**9.Preview the available Imagery**
 
 - Preview the amount of available imagery for the selected ROI between the dates
 
 - In this example ROI 'cwm3' has 18 images available from LandSat 8 and 16 images available from LandSat 9 for the date range
 
 ![case study 1 preview imagery](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/db42fee9-682b-4e15-8470-b97a166e42a8)
 
-**9. Download the ROIs**
+**10. Download the ROIs**
 
 - Click the ROIs you want to download on the map (they will turn blue when selected).
 
@@ -158,7 +179,7 @@ jupyter lab SDS_coastsat_classifier.ipynb
 
 
 
-**10.Extract Shorelines**
+**11.Extract Shorelines**
 ![save_settings_download_extract](https://github.com/Doodleverse/CoastSeg/assets/61564689/3548a9ce-a190-4c95-b495-0ff75484fdb2)
 
 - Extracting shorelines involves loading the ROI data for each selected ROI from `CoastSeg/data/<ROI ID>` and processing the downloaded rasters to extract shorelines. The resulting files are saved in `CoastSeg/sessions/<YOUR SESSION NAME>/ROI_ID_NAME` for each ROI. Note that the downloaded data is NOT copied to the session; instead, the `config.json` file in each session keeps track of the location of the downloaded ROI in `CoastSeg/data`. You can read more about what is in each session in this [guide](https://satelliteshorelines.github.io/CoastSeg/what-is-in-a-session/).

docs/jupyter-notebook-guide.md

@@ -0,0 +1,47 @@
+# How to Use Jupyter Notebook
+
+If you have never used jupyter before I find that this [guide](https://www.dataquest.io/blog/jupyter-notebook-tutorial/) is great!
+
+## 1. How to Run a cell
+
+**Option 1: Keyboard Shortcut: Shift + enter**
+
+- Click shift and enter at the same time to run the selected cell.
+
+- Make sure you click the cell you want to run first
+
+**Option 2: Run the cell with the run cell button**
+
+![run_cell](https://github.com/user-attachments/assets/6bb955a7-edb3-4445-9337-d20d4bb95976)
+
+## 2. How to Restart the Notebook
+
+- If an error occurs while you are running coastseg you may want to restart the notebook.
+
+**Option 1: Restart Button**
+
+
+![image](https://github.com/user-attachments/assets/40ddc63f-250d-461f-be11-4321180e7ad1)
+
+
+**Option 2: Close the notebook & reopen**
+
+1. Open the anaconda prompt terminal where you have coastseg running
+
+2. Enter "crtl + c" at the same time on your keyboard (enter it a few times) to shut down the notebook
+
+
+![ctrl_c_shutdown](https://github.com/user-attachments/assets/8de663b7-b0b1-4038-9cce-dca0482d2aed)
+
+3. Enter 'jupyter lab SDS_coastsat_classifier.ipynb' to open the notebook
+
+![jupyter notebbok open classifier](https://github.com/user-attachments/assets/ed1dddb2-3a01-4572-b2c1-4cc0ff794972)
+
+
+## How to Run all the Cells
+
+- To run all the cells at the same time use the 'run all cells button'
+
+- If you encounter an error please restart the notebook and click the button again to re-run all the cells
+
+![run all cells](https://github.com/user-attachments/assets/3aaa3a87-4a62-4557-846d-37358f528aa5)

mkdocs.yml

@@ -54,6 +54,8 @@ nav:
       - Mac Installation Guide: mac-install-guide.md
       - Update Guide: update-guide.md
   - Getting Started: getting-started.md
+  - Jupyter Notebook Guide:
+      - How to Use Jupyter Notebook: jupyter-notebook-guide.md
   - Case Studies:
       - Case Study 1 An Easy Location in Santa Cruz: case_study_1.md
       - Case Study 2 A Difficult Location in Alaska: case_study_2.md