CoastSeg Scripts Guide¶
This guide provides instructions on how to use the CoastSeg API to download imagery, extract shorelines, and apply tide correction.
Contents¶
- Script 1: Download Imagery and Initial Shoreline Extraction
- Script 2: Extract Shorelines from a previously downloaded session
- Applying Tide Correction (Optional)
Prerequisites¶
- Ensure you have the CoastSeg conda environment set up and activated. If not, please follow the setup instructions provided in the CoastSeg documentation.
- Download the tide model required for tide correction. You can find instructions and download links here.
Running the Scripts¶
Script 1: Download Imagery and Initial Shoreline Extraction¶
1.Activate the CoastSeg Conda Environment:
Open your terminal and activate the CoastSeg conda environment by running:
1 |
|
2.Launch the Script
- Navigate to the directory containing your script and run:
1 |
|
The script performs the following actions:
- Initializes the Google Earth Engine.
- Downloads imagery based on specified regions of interest (ROIs).
- Extracts shorelines from the downloaded imagery.
- Optionally applies tide correction (uncomment the tide correction section if needed).
3.Understanding the Script Output:
- The script will download imagery to the specified data folder.
- Extracted shorelines will be saved in the session's directory.
- Check the terminal for logs and messages indicating the progress and completion of tasks.
Script 2: Extract Shorelines from a previously downloaded session¶
After completing the imagery download and initial extraction, you can proceed with the second script for further shoreline extraction. Note: This script should be run after the first one because it loads the 'sample_session1' created by the first script
1.Activate the CoastSeg Conda Environment:
- Open your terminal and activate the CoastSeg conda environment by running:
1 |
|
2.Uncomment Code to Apply Tide Correction (Optional)
-
The tide model MUST be downloaded as per the prerequisites. Follow a guide here on how to download it How to Download Tide Model
-
Uncomment the tide correction section in the script (shown below):
- make sure to enter the
beach slope
andreference_elevation
(relative to MSL) for your site.
1 |
|
3.Launch the Script
-
Navigate to the directory containing your script and run:
-
This script will use the ROI data downloaded by
1_download_imagery.py
and extract shorelines from the imagery. -
If you did not run
1_download_imagery.py
to download data then this script will not work
1 |
|
It performs the following:
- Loads the download data from a session in 'CoastSeg/data' session created by the first script.
- Applies the new settings to control shoreline extraction from the downloaded imagery
- Optionally, applies tide correction (uncomment and configure if needed).