gust-front-detection-webapp

This is a prototype web interface to interact with the gust front detection algorithm found here.

Table of Contents

• Prerequisites
• Architecture Overview
• Frontend
• Backend
• Docker
• Deployment

Prerequisites

How to setup dependencies for project.

Frontend

To build the frontend:

1. Clone this repository with git clone
2. Navigate to the frontend directory with cd /gust-front-detection-webapp/frontend
3. Install packages with npm install
4. Run frontend with npm run dev

The frontend is now accessible at http://localhost:5173/

Backend

TODO: Add instructions on how to build and run the backend.

Backend directory structure: - app.py contains the API endpoints - apis/ contains the API endpoint definitions - api definitions found here call logic defined in src/ - src/ contains the backend logic - Not responsible for API endpoints that orchestrate or handle HTTP requests - Contains the business logic of the application only

Docker

Describe how to containerize and run the project

Deployment

Explain how the application is deployed

Todo

• Guard against short jobs that run forever for some reason
• Remove "expired" job files and produced resources after set amount of time
• Figure out what is a "reasonable" time to run a historical job and set a hard limit

"Nice to have" features

• Average time to job completion estimator
• Serve tiles instead of individual GeoTIFFs
• Hash job IDs to make them unguessable, so resources can't be directly accessed via URL