Skip to content

Updated the docs #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ediakatos merged 1 commit into from
May 2, 2025
Merged

Updated the docs #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Hazard Processing Tool AWS

A CLI tool to process hazard data (flood, earthquake,
landslide, deforestation, cyclone, coastal erosion) and export results to AWS S3.
landslide, deforestation, cyclone, coastal erosion)
and export results to AWS S3 or locally.

## Poetry Usage

Expand All @@ -22,6 +23,7 @@ poetry --version
- Prepare exposure data from various sources
- Process multiple hazards with xarray and geopandas
- Export processed datasets to S3 using the VSI interface
- Export local
- Configurable via `src/utils/constants.py`
- Interactive web app UI via Streamlit

Expand Down