The console is now the dashboard at / (src/static/dashboard.html); the old page and console.html are gone. - Replay of the October 2024 flood (flood-2024-all.json): the page's clock, verdict, list, markers, flood zones and panel follow the replay; the panel charts the season on fixed axes with the 2024 model's 24 h peak. Hourly while the model alerts or P.1 is above 3.50 m, faster through quiet days; pause and drag. Rain, basin stations and the 5-minute refresh are off during the replay (today's data). - ?demo_level= and ?demo_rise= simulate P.1. A violet REPLAY / amber SIMULATION bar, the top bar's KPI and the P.1 panel say so; the mode is drawn from state.mode alone, so a refresh or language switch cannot relabel either as live. - History: rows without discharge_percent are ThaiWater's copy of the gauge (night hours RID publishes late), with a different rating (P.1: 26 against RID's 54 m3/s); their discharge is not drawn for gauges with RID discharge. The discharge strip has headroom so its label stays clear of the line. - Swap: the old page's title, description, Open Graph and JSON-LD tags; no noindex; tests/test_dashboard.py = console tests + the old checks that still apply (one P.1 level, SEO files) + a replay/simulation labelling test. - Docs: README screenshot (docs/img/dashboard.jpg, replacing two unused images), CLAUDE.md, CONTRIBUTING.md, FLOOD_FORECASTING.md (where the model shows), DASHBOARD_REDESIGN.md (phase 4 done, mode rules). Deploy needs a restart: the server reads dashboard.html at start.
2.6 KiB
2.6 KiB
Contributing
Issues and merge requests on
git.b4l.co.th.
The repository has two halves: the service in Rust (rust/, see
rust/README.md) and the model training/evaluation stack in Python
(src/ml, see docs/FLOOD_FORECASTING.md).
Setup
- Python 3.11 and uv (3.12+ has no pandas 2.0.3 wheels)
- Rust >= 1.88 from rustup, plus
pkg-configandlibssl-devon Linux - Docker (or any PostgreSQL 16) for the database tests
git clone https://git.b4l.co.th/B4L/Northern-Thailand-Ping-River-Monitor.git
cd Northern-Thailand-Ping-River-Monitor
make install # uv sync + pre-commit hooks
docker run -d --name ping-pg -e POSTGRES_PASSWORD=ping -e POSTGRES_DB=ping -p 55432:5432 postgres:16
export TEST_DATABASE_URL=postgres://postgres:ping@localhost:55432/ping
make check # format check, flake8, clippy, pytest, cargo test, Rust 1.88
Without TEST_DATABASE_URL the database tests are skipped, the rest still run.
Before a merge request
make format, thenmake checkgreen. CI runs the same (.gitea/workflows/).- One logical change per commit, imperative subject (
fix(collector): ...,feat(web): ...,docs: ...). - Dashboard changes (
src/static/dashboard.html): every visible string in English and Thai (t()table), no emoji; screenshots (light and dark, phone and desktop) in the merge request. Preview withuv run python scripts/dev_proxy.py. - API changes: keep existing fields and formats; external clients read them. New
parameters go into the route's declaration in
rust/collector/src/web/params.rs, which also documents them at/docs. - Model changes: evaluate with
scripts/evaluate_variants.py(rolling origin, judged on first-alert lead and false alarms) and record the result indocs/FLOOD_FORECASTING.mdsection 5, whether it helped or not. A feature change must be ported torust/forecastin the same change (see CLAUDE.md for the fixture and config regeneration steps). - Never commit credentials,
.env, trained models (models/*.joblib,models/*.json.gz) or the server's private addresses.
Useful commands
make build && make serve # the website/API from your database on 127.0.0.1:8001
uv run python scripts/dev_proxy.py # the working-copy dashboard against the live API
uv run python scripts/evaluate_variants.py --stations P.1
uv run python -m src.ml.export --config # after changing thresholds or notifier settings