Skip to content

Commit

Permalink
update the install guide to include pip install statsmodel bathyreq c…
Browse files Browse the repository at this point in the history
…dsapi
  • Loading branch information
2320sharon committed May 23, 2024
1 parent 744600d commit af376a9
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/install-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,30 @@ Clone the github repo
git clone --depth 1 https://github.com/Doodleverse/SDStools.git
```

Then, to use:
## Install Additional Dependencies

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

- `statsmodel`: Provides statistical models and filters, such as the Hampel Filter.
- `bathyreq `: Allows downloading topobathy data using [BathyReq](https://github.com/NeptuneProjects/BathyReq)
- `cdsapi`: Enables downloading ERA5 wave data from the [CDSAPI](https://pypi.org/project/cdsapi/)

```
conda activate coastseg
cd <location SDS_tools installed>
pip install statsmodel 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 <script_name.py> with the name of the script you want to run.

0 comments on commit af376a9

Please sign in to comment.