update getting started guide with feedback

SatelliteShorelines · Sep 6, 2024 · 1478098 · 1478098
1 parent 327b67b
commit 1478098
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 5 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -2,14 +2,30 @@
 
 **1.Sign up to use Google Earth Engine Python API**
 
-- Request access to Google Earth Engine at https://signup.earthengine.google.com/
+1. Follow the guide to setup Google Earth Engine: [Sign up for Google Earth Engine for the First Time](https://satelliteshorelines.github.io/CoastSeg/google-earth-engine-setup/)
+
+2. Follow the guide to enable Google earth Engine for your project : [Check if Google Earth Engine API is Enabled](https://satelliteshorelines.github.io/CoastSeg/google-earth-enable-api/)
+
+**2. Install Git**
+
+1. Install git on your computer following the guide [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+**3. Install CoastSeg in Anaconda**
+
+ Follow one of the install guides under "Installation" to install CoastSeg.
+
+  - For most users the [basic install guide](https://satelliteshorelines.github.io/CoastSeg/basic-install-guide/) will work 
+
+  - If you are on a secure network then you may need to follow the [secure install guide](https://satelliteshorelines.github.io/CoastSeg/basic-install-guide/)
 
-- It takes about 1 day for Google to approve requests.
 
 ## Installation & SetUp
 
 **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/)
+
 ```bash
 conda activate coastseg
 ```
@@ -21,17 +37,37 @@ conda activate coastseg
 
 **2.Download CoastSeg from GitHub**
 
+- Before you run this step make you have install git on your computer a guide is linked [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+- 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'. 
+
+- After the download finishes close git bash.
+
 ```
+mkdir projects
+cd projects
 git clone --depth 1 https://github.com/SatelliteShorelines/CoastSeg.git
 ```
 
+![git bash](https://github.com/user-attachments/assets/10fdd7c1-ef23-4234-ba01-07489c3f7007)
+
+
 ## Extract Shorelines
 
 **1.Launch Jupyter Lab**
 
+- Open Anaconda prompt
+
 - Run this command in the coastseg directory to launch the notebook `SDS_coastsat_classifier`
 
+- This will open jupyter in a new tab on your browser
+
+- If you have never used jupyter before I find that this [guide](https://www.dataquest.io/blog/jupyter-notebook-tutorial/) is great!
+
 ```bash
+cd <location you installed Coastseg>
 conda activate coastseg
 jupyter lab SDS_coastsat_classifier.ipynb
 ```

diff --git a/docs/google-earth-enable-api.md b/docs/google-earth-enable-api.md
@@ -1,4 +1,4 @@
-# Check if Google Earth Engine API is enabled
+# Check if Google Earth Engine API is Enabled
 
 ### Step 1: Select a project & Services
 
@@ -17,7 +17,7 @@
 
 ### Step 4: Click Earth Engine
 
-![results](https://github.com/user-attachments/assets/50dd9815-fe2e-402a-96ee-8efedf2438ba)
+![pop_up](https://github.com/user-attachments/assets/0a864add-4d20-4f2d-a75b-2333297276af)
 
 ### Step 5: Enable the API
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -46,7 +46,7 @@ markdown_extensions:
 nav:
   - Home: index.md
   - Google Earth Engine Setup: 
-      - 1. First Time Sign Up: google-earth-engine-setup.md
+      - 1. Sign up for Google Earth Engine for the First Time: google-earth-engine-setup.md
       - 2. Check if API is Enabled: google-earth-enable-api.md
   - Installation:
       - Basic Installation Guide: basic-install-guide.md