diff --git a/data/solar_conditions.py b/data/solar_conditions.py index 9ab5e98..aff0d5a 100644 --- a/data/solar_conditions.py +++ b/data/solar_conditions.py @@ -5,7 +5,7 @@ from dataclasses import dataclass # Each threshold-based table is a list of (min_value, description) pairs in descending order; # the first entry whose threshold the value meets or exceeds is used. -BLACKOUT_DESCRIPTIONS = { +XRAY_CLASS_DESCRIPTIONS = { "X": "Wide area HF radio blackout across sunlit side", "M": "Occasional loss of HF communications on sunlit side", "C": "Low absorption of HF signals on sunlit side", @@ -71,6 +71,28 @@ ELECTRON_FLUX_DESCRIPTIONS = [ ] +def _xray_blackout_scale(xray): + """Return the NOAA Radio Blackout scale number (R0-R5) for the given X-ray flux class string + (e.g. "M4.5", "X12").""" + + if not xray or len(xray) < 2: + return 0 + letter = xray[0].upper() + try: + number = float(xray[1:]) + except ValueError: + return 0 + if letter == 'M': + return 1 if number < 5 else 2 + if letter == 'X': + if number < 10: + return 3 + if number < 20: + return 4 + return 5 + return 0 + + def _lookup_by_threshold(value, table, default=None): """Return the description from a threshold table for the given numeric value. The table is a list of (min_value, description) pairs in descending order.""" @@ -108,7 +130,7 @@ class SolarConditions: # K-index (3-hour geomagnetic activity) k_index: int = None # X-ray flux class, e.g. "B2.3", "C1.0" - x_ray: str = None + xray: str = None # Proton flux proton_flux: int = None # Electron flux @@ -141,8 +163,10 @@ class SolarConditions: blackout_forecast_r3_or_greater: dict = None # Derived values (populated by infer_descriptions()) - # HF radio blackout risk description, derived from x_ray - blackout_desc: str = None + # HF radio blackout risk description, derived from xray + xray_desc: str = None + # HF radio blackout scale number (R0-R5), derived from xray + radio_blackout_scale: int = None # Solar radiation storm level description, derived from proton_flux proton_flux_desc: str = None # Solar radiation storm scale number (S0-S5), derived from proton_flux @@ -159,10 +183,9 @@ class SolarConditions: def infer_descriptions(self): """Populate derived text description fields from the current numeric/raw field values.""" - # blackout_desc: use the X-ray flux class letter (first character of x_ray) - if self.x_ray and len(self.x_ray) > 0: - self.blackout_desc = BLACKOUT_DESCRIPTIONS.get(self.x_ray[0].upper()) - + if self.xray and len(self.xray) > 0: + self.xray_desc = XRAY_CLASS_DESCRIPTIONS.get(self.xray[0].upper()) + self.radio_blackout_scale = _xray_blackout_scale(self.xray) self.proton_flux_desc = _lookup_by_threshold(self.proton_flux, PROTON_FLUX_DESCRIPTIONS) self.solar_storm_scale = _lookup_by_threshold(self.proton_flux, SOLAR_STORM_SCALES) self.geomag_storm_desc = _lookup_by_threshold(self.k_index, GEOMAG_STORM_DESCRIPTIONS) diff --git a/server/handlers/pagetemplate.py b/server/handlers/pagetemplate.py index 3f18926..39adc06 100644 --- a/server/handlers/pagetemplate.py +++ b/server/handlers/pagetemplate.py @@ -11,9 +11,11 @@ from core.prometheus_metrics_handler import page_requests_counter class PageTemplateHandler(tornado.web.RequestHandler): """Handler for all HTML pages generated from templates""" - def initialize(self, template_name, web_server_metrics): + def initialize(self, template_name, web_server_metrics, has_hamqsl=False, has_noaa_forecast=False): self._template_name = template_name self._web_server_metrics = web_server_metrics + self._has_hamqsl = has_hamqsl + self._has_noaa_forecast = has_noaa_forecast def get(self): # Metrics @@ -24,4 +26,5 @@ class PageTemplateHandler(tornado.web.RequestHandler): # Load named template, and provide variables used in templates self.render(self._template_name + ".html", software_version=SOFTWARE_VERSION, allow_spotting=ALLOW_SPOTTING, - web_ui_options=WEB_UI_OPTIONS, baseurl = BASE_URL, current_path=self.request.path) \ No newline at end of file + web_ui_options=WEB_UI_OPTIONS, baseurl=BASE_URL, current_path=self.request.path, + has_hamqsl=self._has_hamqsl, has_noaa_forecast=self._has_noaa_forecast) \ No newline at end of file diff --git a/server/webserver.py b/server/webserver.py index af259ca..a942895 100644 --- a/server/webserver.py +++ b/server/webserver.py @@ -21,7 +21,7 @@ from server.handlers.pagetemplate import PageTemplateHandler class WebServer: """Provides the public-facing web server.""" - def __init__(self, spots, alerts, solar_conditions, status_data, port): + def __init__(self, spots, alerts, solar_conditions, status_data, solar_condition_providers, port): """Constructor""" self._spots = spots @@ -30,6 +30,7 @@ class WebServer: self._sse_spot_queues = [] self._sse_alert_queues = [] self._status_data = status_data + self._solar_condition_providers = solar_condition_providers self._port = port self._shutdown_event = asyncio.Event() self.web_server_metrics = { @@ -53,6 +54,12 @@ class WebServer: async def _start_inner(self): """Start method (async). Sets up the Tornado application.""" + provider_classes = [type(p).__name__ for p in self._solar_condition_providers if p.enabled] + has_hamqsl = "HamQSL" in provider_classes + has_noaa_forecast = "NOAA3dayForecast" in provider_classes + page_opts = {"web_server_metrics": self.web_server_metrics, "has_hamqsl": has_hamqsl, + "has_noaa_forecast": has_noaa_forecast} + app = tornado.web.Application([ # Routes for API calls (r"/api/v1/spots", APISpotsHandler, {"spots": self._spots, "web_server_metrics": self.web_server_metrics}), @@ -74,20 +81,15 @@ class WebServer: (r"/api/v1/lookup/grid", APILookupGridHandler, {"web_server_metrics": self.web_server_metrics}), (r"/api/v1/spot", APISpotHandler, {"spots": self._spots, "web_server_metrics": self.web_server_metrics}), # Routes for templated pages - (r"/", PageTemplateHandler, {"template_name": "spots", "web_server_metrics": self.web_server_metrics}), - (r"/map", PageTemplateHandler, {"template_name": "map", "web_server_metrics": self.web_server_metrics}), - (r"/bands", PageTemplateHandler, {"template_name": "bands", "web_server_metrics": self.web_server_metrics}), - (r"/alerts", PageTemplateHandler, - {"template_name": "alerts", "web_server_metrics": self.web_server_metrics}), - (r"/add-spot", PageTemplateHandler, - {"template_name": "add_spot", "web_server_metrics": self.web_server_metrics}), - (r"/conditions", PageTemplateHandler, - {"template_name": "conditions", "web_server_metrics": self.web_server_metrics}), - (r"/status", PageTemplateHandler, - {"template_name": "status", "web_server_metrics": self.web_server_metrics}), - (r"/about", PageTemplateHandler, {"template_name": "about", "web_server_metrics": self.web_server_metrics}), - (r"/apidocs", PageTemplateHandler, - {"template_name": "apidocs", "web_server_metrics": self.web_server_metrics}), + (r"/", PageTemplateHandler, {"template_name": "spots", **page_opts}), + (r"/map", PageTemplateHandler, {"template_name": "map", **page_opts}), + (r"/bands", PageTemplateHandler, {"template_name": "bands", **page_opts}), + (r"/alerts", PageTemplateHandler, {"template_name": "alerts", **page_opts}), + (r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", **page_opts}), + (r"/conditions", PageTemplateHandler, {"template_name": "conditions", **page_opts}), + (r"/status", PageTemplateHandler, {"template_name": "status", **page_opts}), + (r"/about", PageTemplateHandler, {"template_name": "about", **page_opts}), + (r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", **page_opts}), # Route for Prometheus metrics (r"/metrics", PrometheusMetricsHandler), # Default route to serve from "webassets" diff --git a/solarconditionsproviders/hamqsl.py b/solarconditionsproviders/hamqsl.py index 92e0961..1d51aa5 100644 --- a/solarconditionsproviders/hamqsl.py +++ b/solarconditionsproviders/hamqsl.py @@ -86,7 +86,7 @@ class HamQSL(HTTPSolarConditionsProvider): "sfi": int_val("solarflux"), "a_index": int_val("aindex"), "k_index": int_val("kindex"), - "x_ray": text("xray"), + "xray": text("xray"), "sunspots": int_val("sunspots"), "proton_flux": int_val("protonflux"), "electron_flux": int_val("electonflux"), diff --git a/spothole.py b/spothole.py index 8a2fe1f..4e917ce 100644 --- a/spothole.py +++ b/spothole.py @@ -97,7 +97,8 @@ if __name__ == '__main__': lookup_helper.start() # Set up web server - web_server = WebServer(spots=spots, alerts=alerts, solar_conditions=solar_conditions, status_data=status_data, port=WEB_SERVER_PORT) + web_server = WebServer(spots=spots, alerts=alerts, solar_conditions=solar_conditions, status_data=status_data, + solar_condition_providers=solar_condition_providers, port=WEB_SERVER_PORT) # Fetch, set up and start spot providers for entry in config["spot-providers"]: diff --git a/templates/about.html b/templates/about.html index e2598b6..d8c2c0f 100644 --- a/templates/about.html +++ b/templates/about.html @@ -67,7 +67,7 @@
This software is dedicated to the memory of Tom G1PJB, SK, a friend and colleague who sadly passed away around the time I started writing it in Autumn 2025. I was looking forward to showing it to you when it was done.
- + {% end %} \ No newline at end of file diff --git a/templates/add_spot.html b/templates/add_spot.html index c4bbeae..6d8a22c 100644 --- a/templates/add_spot.html +++ b/templates/add_spot.html @@ -69,8 +69,8 @@ - - + + {% end %} \ No newline at end of file diff --git a/templates/alerts.html b/templates/alerts.html index 8e56d6e..43b3cac 100644 --- a/templates/alerts.html +++ b/templates/alerts.html @@ -56,8 +56,8 @@ - - + + {% end %} \ No newline at end of file diff --git a/templates/bands.html b/templates/bands.html index dcf1eb2..ded7b0f 100644 --- a/templates/bands.html +++ b/templates/bands.html @@ -62,9 +62,9 @@ - - - + + + {% end %} \ No newline at end of file diff --git a/templates/base.html b/templates/base.html index 9df4add..87d0c96 100644 --- a/templates/base.html +++ b/templates/base.html @@ -46,10 +46,10 @@ crossorigin="anonymous"> - - - - + + + + @@ -71,7 +71,9 @@ {% if allow_spotting %}| '); - entries.forEach(({ ts }) => { + entries.forEach(({ts}) => { const label = new Date(ts * 1000) - .toLocaleDateString('en-US', { day: '2-digit', month: 'short', timeZone: 'UTC' }); + .toLocaleDateString('en-GB', {day: '2-digit', month: 'short', timeZone: 'UTC'}); headRow.append(` | ${label} | `); }); // Single data row: "S1 or greater" label + one cell per date const tr = $('||
|---|---|---|---|
| S1 or greater | '); - entries.forEach(({ pct }) => { + entries.forEach(({pct}) => { const td = $('').text(pct + '%'); td.addClass(pct < 50 ? 'bg-success-subtle' : pct < 75 ? 'bg-warning-subtle' : 'bg-danger-subtle'); tr.append(td); @@ -288,15 +316,15 @@ function renderBlackoutForecast(r1r2Data, r3Data) { .map(tsStr => ({ ts: parseFloat(tsStr), r1r2: r1r2Data ? r1r2Data[tsStr] : undefined, - r3: r3Data ? r3Data[tsStr] : undefined + r3: r3Data ? r3Data[tsStr] : undefined })) .sort((a, b) => a.ts - b.ts); // Header const headRow = $('#forecast-blackout-head').empty().append(' | '); - entries.forEach(({ ts }) => { + entries.forEach(({ts}) => { const label = new Date(ts * 1000) - .toLocaleDateString('en-GB', { day: '2-digit', month: 'short', timeZone: 'UTC' }); + .toLocaleDateString('en-GB', {day: '2-digit', month: 'short', timeZone: 'UTC'}); headRow.append(` | ${label} | `); }); @@ -316,31 +344,37 @@ function renderBlackoutForecast(r1r2Data, r3Data) { } $('#forecast-blackout-tbody').empty() - .append(makeRow('R1-R2', e => e.r1r2)) + .append(makeRow('R1-R2', e => e.r1r2)) .append(makeRow('R3 or greater', e => e.r3)); } // Render the DX stats table for the currently selected DE continent function renderDxStats() { - if (!dxStatsData) { return; } + if (!dxStatsData) { + return; + } const deContinent = $('#dxstats-de-continent').val(); const deData = dxStatsData[deContinent]; - if (!deData) { return; } + if (!deData) { + return; + } const cells = []; - Object.entries(deData).forEach(function([dxContinent, bands]) { - Object.entries(bands).forEach(function([band, count]) { + Object.entries(deData).forEach(function ([dxContinent, bands]) { + Object.entries(bands).forEach(function ([band, count]) { const cell = $('#dxstats-' + dxContinent + '-' + band); cell.text(count); - cells.push({ cell, count }); + cells.push({cell, count}); }); }); - const counts = cells.map(function(c) { return c.count; }); + const counts = cells.map(function (c) { + return c.count; + }); const min = Math.min(...counts); const max = Math.max(...counts); const range = max - min; - cells.forEach(function({ cell, count }) { + cells.forEach(function ({cell, count}) { const t = range > 0 ? (count - min) / range : 0; const cls = t === 0 ? 'bg-danger-subtle' : t < 0.05 ? 'bg-warning-subtle' : 'bg-success-subtle'; cell.removeClass('bg-danger-subtle bg-warning-subtle bg-success-subtle').addClass(cls); @@ -355,14 +389,14 @@ function dxStatsContientChanged() { // Fetch DX stats from the API and render function loadDxStats() { - $.getJSON('/api/v1/dxstats', function(jsonData) { + $.getJSON('/api/v1/dxstats', function (jsonData) { dxStatsData = jsonData; renderDxStats(); }); } // Startup -$(document).ready(function() { +$(document).ready(function () { loadSettings(); loadSolarConditions(); loadDxStats();