HFRNet Application

HFRNet (High Frequency Radar Network) is the U.S. national network of shore-based high-frequency radars that measure ocean surface currents in near real time. This repository contains the web application used to ingest, serve, and visualize that data, along with the operational scripts that keep the network's datasets current.

---

Architecture

The application is made up of three deployable components plus a collection of operational scripts:

Component	Path	Stack	Purpose
Client	client/	PHP + JavaScript (webpack)	Frontend web app: interactive map of surface currents, diagnostics, and site status views.
API	api/	Python (Flask)	Backend serving radial, total-vector, and wave data endpoints.
Database	database/	MySQL 8.0	Schema and container for the hfradar, metrics, outages, and rtvproc databases.
Scripts	scripts/	Python	Operational jobs for data acquisition, metrics, verification, and maintenance.

flowchart LR
    radarSites["HF radar sites / S3"] --> scripts["Acquisition & processing scripts"]
    scripts --> db[("MySQL databases")]
    api["Flask API"] --> db
    api --> s3[("S3 data store")]
    client["PHP + JS client"] --> api
    user["Browser"] --> client

Loading

---

Quick Start

The repo root contains a single Docker Compose file that starts the client, API, and database together. You just need two .env files first:

1. Configure environment files:

   cp .env.example .env          # set GOOGLE_MAPS_API_KEY
   cp api/.env.example api/.env  # set HFRNET_DIR and AWS credentials

2. Start everything:

   docker compose up --build

   Service	URL
   Client	http://localhost:3000
   API	http://localhost:5000
   Database	localhost:3306 (MySQL)

   The database starts first; the API and client wait until it is healthy.

Each component can also be run on its own with the Docker Compose file in its directory (this requires creating the shared network first with docker network create hfrnet). See the component READMEs for full instructions: API README, Client README, Database README.

---

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration (NOAA), or the United States Department of Commerce (DOC). All NOAA GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. Any claims against the DOC or DOC bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation, or favoring by the DOC. The DOC seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.