# Windfield

> Windfield (windfield.summitflux.com) is a free, no-login web front end for
> the USFS WindNinja 4.0 diagnostic (mass-conserving) terrain wind model.
> Draw an area on a map, set the wind
> (or use live weather, or a weather-model forecast), and get back a
> terrain-adjusted wind field: a colour speed raster, direction arrows, an
> animated particle view, downloadable GeoTIFF/KMZ/shapefile/ASCII, and a
> stats summary. Everything is free; there is no account and no paywall.

## Using it as an API

Base URL: `https://windfield.summitflux.com/api/v1` (JSON, no auth, no key).

- `GET /capabilities` — current budgets (max cells, max run seconds, mesh
  resolution range) and supported options (vegetation, mesh choices,
  weather models). Read this first; limits may change.
- `POST /jobs` — start a run. Body includes `bbox` ([west,south,east,north]
  in WGS84 degrees), `initialization` (`domain_average`|`point`|`weather_model`),
  wind speed/direction/height, vegetation, mesh choice or resolution, and
  optional `structures` (polygons raised to a height, or infinite). Returns
  `{ id, status, status_url }`.
- `GET /jobs/{id}` — poll status/progress; when done, `results` has the
  speed PNG, arrows GeoJSON, a probe-able grid.json, download links and
  stats (min/max/mean speed, run seconds).
- `GET /jobs/{id}/files/{name}` — fetch a specific output file.
- `GET /geocode?q=` — place search (proxies OpenStreetMap Nominatim).
- `GET /weather/current?lat=&lon=` — live conditions for a point (proxies Open-Meteo).

There is no cost and no key required; please keep request rates reasonable
(the service enforces per-IP limits and will answer 429 if you exceed them).

## Attribution

If you cite or redistribute results: "WindNinja (USDA Forest Service,
Missoula Fire Sciences Lab), run via windfield.summitflux.com, terrain from
AWS Terrain Tiles." Full attribution: https://windfield.summitflux.com/credits.html

## More

- Full API shape: see the OpenAPI-ish description at /api/v1/capabilities
  and the longer human write-up at /llms-full.txt
- About / methodology: https://windfield.summitflux.com/about.html
- How it works (the physics and the pipeline): https://windfield.summitflux.com/how-it-works.html
- This is a SummitFlux LLC (https://summitflux.com) project, offered free
  for the time being.