Skip to content

Updated README logical sqnc #16

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 README logical sqnc #16

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
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,6 @@ make .venv # Install dependencies
make hooks # Install pre-commit hooks
```

## Usage

```bash
make aws_etl # Run the hazard processing pipeline
make local_etl # Run the hazard processing pipeline locally without S3
make test # Run unit tests
make lint # Run lint checks
make app # Run the interactive Streamlit application
```

## Configuration

Create a `~/.hazard_tool_rc` file in your home directory
Expand All @@ -61,13 +51,23 @@ with the following environment variables:
export S3_BUCKET=<your-s3-bucket>
export AWS_ACCESS_KEY_ID=<your-aws-access-key-id>
export AWS_SECRET_ACCESS_KEY=<your-aws-secret-access-key>
export AWS_DEFAULT_REGION=<your-aws-default-region>
export AWS_DEFAULT_REGION=eu-west-2
export USE_LOCAL=true
```

Optionally, adjust path constants (e.g., `ADMIN_VECTOR_PATH`, `POPULATION_RASTER_PATH`)
directly in `src/utils/constants.py` if needed.

## Usage

```bash
make aws_etl # Run the hazard processing pipeline
make local_etl # Run the hazard processing pipeline locally without S3
make test # Run unit tests
make lint # Run lint checks
make app # Run the interactive Streamlit application
```

## Project Structure

```bash
Expand Down