Using this from an agent or a script
Start at /llms.txt. It has the walk below in plain text, every endpoint, and every known data issue, and it is regenerated with the data. The formal contract is /api/openapi.json, together with the JSON Schema that each document names in $schema.
The walk
GET /api/index.json: every endpoint and every file with its size and SHA-256, the API version, thedata_version, the changelog, the licence and how to cite. If the Pages site is unreachable,fallback_base_urlserves the identical files raw from the repository./api/always serves the newest release, and/api/versions.jsonlists every release with thebase_urlof its frozen copy (see the first rule below).GET /api/cases.json: every case with its frame, units, counts, engine status and links. Pick anid.GET /api/cases/{id}.json: readframe,unitsandknown_issuesbefore the numbers, because they differ per case. A–D and H–L are model-scale metres with \(+x\) along the wind. E, F, G and M are full-scale metres: E and F with \(+x\) east, \(+y\) north and meteorological directions, G with \(+x\) downwind, M with \(+x\) north and \(+y\) west.configurationslists the valuesconfig,campaign,instrument,runandwind_direction_degtake in the point table.GET /api/cases/{id}/points.json(or thepoints.csvdownload): every value is SI (m, m/s, m²/s²), in one frame per case. Unmeasured values arenull(an empty cell in CSV).columnslists the fields present, andcolumn_meaningdefines each. Case E’s quantity is a dimensionlessvelocity_ratio(\(V_{\mathrm{s}}/U(15.9\text{ m})\), with \(U(15.9\text{ m})\) = 3.935 m/s); Cases F and G are ratios too (velocity_ratio,k_ratio), against a reference stated in the case’snormalisation. Cases H to M add a tracer concentrationCin ppm, withconcentration_rationormalised as the case states, and J and L add temperature and turbulent fluxes.GET /api/cases/{id}/geometry.json, then the STL it links: metres, outward normals, origin at the building or array centre. Where the geometry is boxes (A–D and G–L), the JSON carries the box list, so you need not parse STL.GET /api/validation.json: every case and engine in one table. An engine whose status is notscoredhas no result for that case; do not infer one. For one case in full,GET /api/cases/{id}/validation.json: every score, theheadlinescores to quote, the figures, andpairs, the per-point measured and modelled values behind the scores.
Rules for a comparison
- Pin the release when a result must be reproducible. Take the
base_urlof the release you used from/api/versions.json(for example.../api/3.1.0) and fetch every path from it instead of from/api/. The unversioned paths follow the newest release, so a script that uses them can return different numbers after the next release, while a release’s copy never changes and every API URL inside its documents points back into it. Quote the release number together withdata_version. If a release listsself_contained: false, its documents link outside its copy: build its URLs frombase_urland thepathin itsindex.json. - Normalise by the case’s own \(U_H\) (
configuration.U_H_m_s), or for Case E by \(U(15.9\text{ m})\); normalise \(k\) by \(U_H^2\). Cases F and G are published as ratios already: read theirnormalisationbefore comparing. - Compare a thermistor quantity (C, D, E, F:
Vs,velocity_ratio) against the bracket \(\lvert\mathbf{U}\rvert\) ≤ \(V_{\mathrm{s}}\) ≤ \(\sqrt{\lvert\mathbf{U}\rvert^2 + 2k}\), not against \(\lvert\mathbf{U}\rvert\) alone. - Compare a concentration through
concentration_ratioand the case’s ownnormalisation(\(c_0\) is defined per case, and in Case K the workbook and the data paper use different reference scales). Case M’s tunnel and field rows are two campaigns: filter oncampaign. - Probe at the published coordinates; never interpolate the reference.
- The served tables already apply each case’s corrections: Case B’s \(V\) is sign-unified and its coordinates are in metres. Do not apply those corrections a second time when starting from the raw files.
- Use the download URLs the documents give rather than building them yourself, and check each file against its
sha256. - Send a descriptive
User-Agent. The site’s CDN rejects Pythonurllib’s default one and some AI crawlers with HTTP 403. If you are refused anyway,fallback_base_urlserves byte-identical files from the repository. - Cite the release you pinned and quote its version:
cite.apiin that release’sindex.json.
Scoring your own solver
GET /api/cases/{id}/probes.csv is the list of points to probe, and scoring and inflow in /api/cases/{id}.json are the constants and the inlet contract. /api/cases/{id}/inflow_openfoam.txt is that inlet as OpenFOAM files. uv run python validation/score_submissions.py <folder>, from a checkout, scores a folder of your values. The walk is Validate your own solver; submitted results are served at /api/submissions.json and shown on Community results, apart from Eddy3D’s own.
Cite
The API: cite.api in /api/index.json (apa, bibtex, csl_json). A case’s dataset: citation and doi in /api/cases/{id}.json. The same citations, with the data paper’s, are on the About and cite page.