From 327b67b06e521742c3c3e5e0c76949ea2d722e8d Mon Sep 17 00:00:00 2001 From: Sharon Fitzpatrick Date: Thu, 5 Sep 2024 16:21:47 -0700 Subject: [PATCH] add docs for gee earth engine set up --- docs/google-earth-enable-api.md | 26 ++++++++++++++++++ docs/google-earth-engine-setup.md | 44 +++++++++++++++++++++++++++++++ mkdocs.yml | 5 +++- 3 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 docs/google-earth-enable-api.md create mode 100644 docs/google-earth-engine-setup.md diff --git a/docs/google-earth-enable-api.md b/docs/google-earth-enable-api.md new file mode 100644 index 00000000..3d8fb28a --- /dev/null +++ b/docs/google-earth-enable-api.md @@ -0,0 +1,26 @@ +# Check if Google Earth Engine API is enabled + +### Step 1: Select a project & Services + +1. Click the dropdown and select the project you just made +2. Click the "API & Services" button + +![console page](https://github.com/user-attachments/assets/05ca60bb-35a2-4b93-ba96-3039d0b36c07) + +### Step 2: Click Enable API + +![enable api](https://github.com/user-attachments/assets/2462f9e2-0d92-4062-8267-8bc115e1336c) + +### Step 3: Search for "earth engine" + +![search](https://github.com/user-attachments/assets/e0296b63-ae3c-460e-9af2-3241e44dba22) + +### Step 4: Click Earth Engine + +![results](https://github.com/user-attachments/assets/50dd9815-fe2e-402a-96ee-8efedf2438ba) + +### Step 5: Enable the API + +Your API should already be enabled but if its not then, click manage. + +![enabled_api](https://github.com/user-attachments/assets/75ffb6d7-083c-4321-9caf-983505f6e2ec) \ No newline at end of file diff --git a/docs/google-earth-engine-setup.md b/docs/google-earth-engine-setup.md new file mode 100644 index 00000000..95da1c60 --- /dev/null +++ b/docs/google-earth-engine-setup.md @@ -0,0 +1,44 @@ +# Sign Up for Google Earth Engine + +### Step 1: + +Visit: https://code.earthengine.google.com/register + +![1_sign_up_screen](https://github.com/user-attachments/assets/17b4108a-32f3-4a54-b813-9c0a4bddb539) + +### Step 2: +![2_paid_useage](https://github.com/user-attachments/assets/7415ff08-678f-4562-b313-2017d0da6593) + + +### Step 3: + +1. Create a project and name it. +2. Scroll to the bottom and click the link to accept the terms + +![3_create_project](https://github.com/user-attachments/assets/ae886d6a-7247-4080-8ac5-7536cb13901f) +![alt text](image-3.png) + +### Step 4: + +When you click the link to accept the terms a pop up will open. Click agree and then click the button to continue + +![alt text](image-4.png) + +### Step 5: + +1. Once you accept go back to the page you were on for step 3. +2. Confirm the project information + +![4_confirm](https://github.com/user-attachments/assets/a8e9cbd9-93b1-404f-91c1-4da0c2bdda1c) + +## Step 6: + +After you click confirm the GEE console will open. Close it. We will not be using it. + +![5_console](https://github.com/user-attachments/assets/33806a7b-c75f-4afa-a206-6d84ffa9399d) + +## Step 7: Go to the next guide + +Check the next guide titled 'Check if API is Enabled' +- This will let you check if the Google Earth Engine API was enabled the project you just made + diff --git a/mkdocs.yml b/mkdocs.yml index b04f3224..230ba923 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,6 +45,9 @@ markdown_extensions: nav: - Home: index.md + - Google Earth Engine Setup: + - 1. First Time Sign Up: google-earth-engine-setup.md + - 2. Check if API is Enabled: google-earth-enable-api.md - Installation: - Basic Installation Guide: basic-install-guide.md - Secure Installation Guide: secure-install-guide.md @@ -61,7 +64,7 @@ nav: - Getting Started to Contribute: Getting-Started_to_contribute.md - How to Contribute Transects: contribute-transects.md - How to Test the Zoo Workflow: test-zoo-workflow.md - - How to edit the website: edit-website.md + - How to edit the website: contribute-how-edit-website.md # - Technical Documentation: technical-documentation.md - Tutorials: - How to authenticate with Google Earth Engine: how-to-auth.md