Skip to content

Commit

Permalink
update the getting started and map guide
Browse files Browse the repository at this point in the history
  • Loading branch information
2320sharon committed Apr 19, 2024
1 parent fee8089 commit d4c0c7c
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 16 deletions.
21 changes: 11 additions & 10 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
Check out the rest of the [wiki](https://github.com/Doodleverse/CoastSeg/wiki) for more tutorials

## Prerequisites

1. Sign up to use Google Earth Engine Python API
**1.Sign up to use Google Earth Engine Python API**

-Request access to Google Earth Engine at https://signup.earthengine.google.com/
- Request access to Google Earth Engine at https://signup.earthengine.google.com/

-It takes about 1 day for Google to approve requests.
- It takes about 1 day for Google to approve requests.

## Installation & SetUp

1. Activate the coastseg conda environment
```bash
conda activate coastseg
```
**1.Activate the coastseg conda environment**

```bash
conda activate coastseg
```

- If you have successfully activated coastseg you should see that your terminal's command line prompt should now start with `(coastseg)`.

<img src="https://user-images.githubusercontent.com/61564689/184215725-3688aedb-e804-481d-bbb6-8c33b30c4607.png"
alt="coastseg activated in anaconda prompt" width="350" height="150">

2. Download CoastSeg from GitHub
**2.Download CoastSeg from GitHub**

```
git clone coastseg --depth 1 https://github.com/Doodleverse/CoastSeg.git
Expand All @@ -47,6 +46,8 @@ jupyter lab SDS_coastsat_classifier.ipynb

- 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/)

**6.Modify the Settings**

- Change the satellites to L8 and L9
Expand Down
33 changes: 27 additions & 6 deletions docs/map_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,42 @@

**Not able to hover over a feature on the map?** The problem is its under another layer on the map. Most likely the feature you want to hover over is under the ROI and selected ROI layers. Use the layers menu checkbox to deselect the ROI and selected ROI layers from the map and hover over your feature again.

![Alt text](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/change_layer_demo.gif)
![change_layer_demo](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/9c8d65d5-85c8-457b-993c-6dc7122f332f)

## How to Load Transects on the Map

---

To load transects on the map first draw a bounding box along the coastline. Then click the button `Load Transects` to load transects within the bounding box.
**WARNING**: Not all coastlines have transects available and if no transects exist within the bounding box a pop up will indicate that no transects were found. If this happens try drawing a bounding box somewhere else.

![Alt text](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/load_shoreline_transect_demo.gif)
![load_shoreline_transect_demo](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/7b47bc38-6e10-4f3c-93d9-117990cb1fec)

## How to Load Shorelines on the Map

---

To load shorelines on the map first draw a bounding box along the coastline. Then click the button `Load Shoreline` to load shorelines within the bounding box.
**WARNING**: Not all coastlines have shoreline vectors available and if no shorelines exist within the bounding box a pop up will indicate that no shorelines were found. If this happens try drawing a bounding box somewhere else.

![Alt text](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/load_shoreline_transect_demo.gif)
![load_shoreline_transect_demo](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/7b47bc38-6e10-4f3c-93d9-117990cb1fec)

## How to Load Features from Geojson Files

---

**1.Click the dropdown from under 'Load Feature from File'**

- Select the feature you want on the map.

**2.Click the load button from under 'Load Feature from File'**

- This opens a file dialog window where you can select the geojson file you want to load on the map.

![load feature from file](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/3e314de6-a742-46e9-b390-36d66e7aaba9)

**3.Select a geoJSON file containing the feature**

## How to Load Features from Geojson Files on Map
To load shorelines, transects or bounding boxes onto the map from a geojson file use the `Load <feature name> file` button. It will open a file dialog window where you can select the geojson file you want to load on the map. If the geojson file is too large or has too many large features the map may become very slow. It is highly recommended to only load small features onto the map.
- If the geojson file is too large or has too many large features the map may become very slow. It is highly recommended to only load small features onto the map.

![Alt text](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/load_geojson_files_demo.gif)
![load_geojson_files_demo](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/4fedfb32-b36b-4203-a9af-228f927ca0a8)

0 comments on commit d4c0c7c

Please sign in to comment.