How to Install¶

Currently, SDS_tools runs in the coastseg environment. Follow the CoastSeg installation guide to set up a conda environment with CoastSeg installed then in this activate environment run any of the SDS_tools scripts.

Clone¶

Clone the github repo

1	`git clone --depth 1 https://github.com/Doodleverse/SDStools.git`

Install Additional Dependencies¶

SDS tools differs from CoastSeg in that it uses 3 additional dependencies

statsmodels: Provides statistical models and filters, such as the Hampel Filter. See here
bathyreq: Allows downloading topobathy data using BathyReq
cdsapi: Enables downloading ERA5 wave data from the CDSAPI

conda activate coastseg
cd <location SDS_tools installed>
pip install statsmodels bathyreq cdsapi

How to Use the Scripts¶

After installing the dependencies, activate the CoastSeg environment, navigate to the scripts directory within SDS_tools, and run the desired script.

conda activate coastseg
cd <location SDS_tools installed>
cd scripts
python <script_name.py>

Replace with the name of the script you want to run.