mostlyright

Interfaces

CatalogEntry

One entry in the per-domain catalog manifest (generated from the Python registry; committed at @mostlyrightmd/weather/catalog). The injected source of truth for the kind: "source" discover rows.

Properties

availability

readonly availability: ManifestAvailability

columns?

readonly optional columns: readonly string[]

domain

readonly domain: string

entity?

readonly optional entity: string

id

readonly id: string

kind

readonly kind: string

license?

readonly optional license: string

note?

readonly optional note: string

pit_fidelity?

readonly optional pit_fidelity: string

point_in_time_fidelity?

readonly optional point_in_time_fidelity: string

units?

readonly optional units: Readonly<Record<string, string>>

usage?

readonly optional usage: CatalogUsage

CatalogUsage

Language-tagged usage snippet carried by a catalog entry.

Properties

py?

readonly optional py: string

ts?

readonly optional ts: string

DailyExtremesTrainingTableRow

A label: "daily_extremes" supervised row — the Polymarket WU/NOAA-WRH settlement columns (daily_extremes_*, both °C and °F) beside the feature block. Mirrors Python RECIPE_LABEL_COLUMNS["daily_extremes"]; it carries no daily_summary_* columns, because the daily_extremes recipe has none.

Extends

TrainingTableRowBase

Properties

daily_extremes_high_c

readonly daily_extremes_high_c: null | number

daily_extremes_high_f

readonly daily_extremes_high_f: null | number

daily_extremes_low_c

readonly daily_extremes_low_c: null | number

daily_extremes_low_f

readonly daily_extremes_low_f: null | number

daily_extremes_mean_c

readonly daily_extremes_mean_c: null | number

daily_extremes_mean_f

readonly daily_extremes_mean_f: null | number

daily_extremes_observation_count

readonly daily_extremes_observation_count: null | number

daily_extremes_source_high

readonly daily_extremes_source_high: null | string

daily_extremes_source_low

readonly daily_extremes_source_low: null | string

decision_time_utc

readonly decision_time_utc: string

The settlement decision cutoff (a model would have acted “as of” this instant).

Inherited from

TrainingTableRowBase.decision_time_utc

knowable_at_utc

readonly knowable_at_utc: string

max(decision_time_utc, label_available_time_utc) — when the row first became computable.

Inherited from

TrainingTableRowBase.knowable_at_utc

label_available_time_utc

readonly label_available_time_utc: string

When the settlement label was published/available.

Inherited from

TrainingTableRowBase.label_available_time_utc

local_standard_date

readonly local_standard_date: string

Inherited from

TrainingTableRowBase.local_standard_date

observation_count

readonly observation_count: number

Inherited from

TrainingTableRowBase.observation_count

observed_dewpoint_mean_f

readonly observed_dewpoint_mean_f: null | number

Inherited from

TrainingTableRowBase.observed_dewpoint_mean_f

observed_precipitation_total_in

readonly observed_precipitation_total_in: null | number

Inherited from

TrainingTableRowBase.observed_precipitation_total_in

observed_temp_high_f

readonly observed_temp_high_f: null | number

Inherited from

TrainingTableRowBase.observed_temp_high_f

observed_temp_low_f

readonly observed_temp_low_f: null | number

Inherited from

TrainingTableRowBase.observed_temp_low_f

observed_temp_mean_f

readonly observed_temp_mean_f: null | number

Inherited from

TrainingTableRowBase.observed_temp_mean_f

observed_wind_gust_max_kt

readonly observed_wind_gust_max_kt: null | number

Inherited from

TrainingTableRowBase.observed_wind_gust_max_kt

observed_wind_max_kt

readonly observed_wind_max_kt: null | number

Inherited from

TrainingTableRowBase.observed_wind_max_kt

station

readonly station: string

Inherited from

TrainingTableRowBase.station

DailySummaryTrainingTableRow

A label: "daily_summary" supervised row — the Kalshi NHIGH/NLOW settlement columns (daily_summary_*) beside the feature block. Mirrors Python RECIPE_LABEL_COLUMNS["cli"]; it carries no daily_extremes_* columns.

Extends

TrainingTableRowBase

Properties

daily_summary_report_type

readonly daily_summary_report_type: null | string

daily_summary_temp_high_f

readonly daily_summary_temp_high_f: null | number

daily_summary_temp_low_f

readonly daily_summary_temp_low_f: null | number

decision_time_utc

readonly decision_time_utc: string

The settlement decision cutoff (a model would have acted “as of” this instant).

Inherited from

TrainingTableRowBase.decision_time_utc

knowable_at_utc

readonly knowable_at_utc: string

max(decision_time_utc, label_available_time_utc) — when the row first became computable.

Inherited from

TrainingTableRowBase.knowable_at_utc

label_available_time_utc

readonly label_available_time_utc: string

When the settlement label was published/available.

Inherited from

TrainingTableRowBase.label_available_time_utc

local_standard_date

readonly local_standard_date: string

Inherited from

TrainingTableRowBase.local_standard_date

observation_count

readonly observation_count: number

Inherited from

TrainingTableRowBase.observation_count

observed_dewpoint_mean_f

readonly observed_dewpoint_mean_f: null | number

Inherited from

TrainingTableRowBase.observed_dewpoint_mean_f

observed_precipitation_total_in

readonly observed_precipitation_total_in: null | number

Inherited from

TrainingTableRowBase.observed_precipitation_total_in

observed_temp_high_f

readonly observed_temp_high_f: null | number

Inherited from

TrainingTableRowBase.observed_temp_high_f

observed_temp_low_f

readonly observed_temp_low_f: null | number

Inherited from

TrainingTableRowBase.observed_temp_low_f

observed_temp_mean_f

readonly observed_temp_mean_f: null | number

Inherited from

TrainingTableRowBase.observed_temp_mean_f

observed_wind_gust_max_kt

readonly observed_wind_gust_max_kt: null | number

Inherited from

TrainingTableRowBase.observed_wind_gust_max_kt

observed_wind_max_kt

readonly observed_wind_max_kt: null | number

Inherited from

TrainingTableRowBase.observed_wind_max_kt

station

readonly station: string

Inherited from

TrainingTableRowBase.station

DiscoverFilters

Structured filters — none of them change the return type.

Properties

availability?

readonly optional availability: "python" | "typescript"

catalog?

readonly optional catalog: readonly CatalogEntry[]

The catalog manifest entries for the source rows (inject or loadWeatherCatalog()).

domain?

readonly optional domain: string

kind?

readonly optional kind: "source" | "station"

DiscoverSourceRow

A registered data-source hit.

Properties

availability

readonly availability: readonly string[]

domain

readonly domain: string

id

readonly id: string

kind

readonly kind: "source"

name

readonly name: string

note

readonly note: string

point_in_time_fidelity

readonly point_in_time_fidelity: null | string

usage_ts

readonly usage_ts: string

The TS-facing usage snippet (never a bare Python snippet).

DiscoverStationRow

A bundled-catalog station hit.

Properties

country

readonly country: null | string

domain

readonly domain: string

id

readonly id: string

kind

readonly kind: "station"

latitude

readonly latitude: null | number

longitude

readonly longitude: null | number

name

readonly name: string

note

readonly note: string

timezone

readonly timezone: null | string

TrainingTableOptions

The options trainingTable accepts. Only label — no transport, cache, or clock options.

Properties

label?

readonly optional label: Label

The settlement label recipe — "daily_summary" (default, Kalshi NHIGH/NLOW) or "daily_extremes" (Polymarket WU/NOAA-WRH).

TrainingTableRowBase

The label-independent columns of a supervised row: the observation feature aggregates, the (station, local_standard_date) key, and the three temporal columns. snake_case keys serialize identically to the Python schema.core.training_table.v1 frame.

Properties

decision_time_utc

readonly decision_time_utc: string

The settlement decision cutoff (a model would have acted “as of” this instant).

knowable_at_utc

readonly knowable_at_utc: string

max(decision_time_utc, label_available_time_utc) — when the row first became computable.

label_available_time_utc

readonly label_available_time_utc: string

When the settlement label was published/available.

local_standard_date

readonly local_standard_date: string

observation_count

readonly observation_count: number

observed_dewpoint_mean_f

readonly observed_dewpoint_mean_f: null | number

observed_precipitation_total_in

readonly observed_precipitation_total_in: null | number

observed_temp_high_f

readonly observed_temp_high_f: null | number

observed_temp_low_f

readonly observed_temp_low_f: null | number

observed_temp_mean_f

readonly observed_temp_mean_f: null | number

observed_wind_gust_max_kt

readonly observed_wind_gust_max_kt: null | number

observed_wind_max_kt

readonly observed_wind_max_kt: null | number

station

readonly station: string

Type Aliases

DiscoverRow

DiscoverRow: DiscoverStationRow | DiscoverSourceRow

One discover row — a discriminated union on kind.

Label

Label: "daily_summary" | "daily_extremes"

The settlement-label recipe selector.

ManifestAvailability

ManifestAvailability: string | ReadonlyArray<string>

A manifest availability value: the language-name list or a legacy comma-string.

TrainingTableRow

TrainingTableRow: DailySummaryTrainingTableRow | DailyExtremesTrainingTableRow

One supervised row. The label-specific column set is mutually exclusive (matching Python RECIPE_LABEL_COLUMNS): label: "daily_summary" yields a DailySummaryTrainingTableRow (the daily_summary_* Kalshi columns), label: "daily_extremes" a DailyExtremesTrainingTableRow (the daily_extremes_* Polymarket columns). Narrow with an in check, e.g. "daily_extremes_high_f" in row.

Variables

version

const version: "4.1.0" = "4.1.0"

Public package version; kept in lockstep with package.json.

Functions

discover()

discover(query, filters): DataResult<DiscoverRow>

Discover stations and data sources in one discriminated envelope.

Parameters

query

string

filters

DiscoverFilters = {}

Returns

DataResult<DiscoverRow>

Example

const { rows } = discover("nyc");                       // station hits
  const { rows } = discover("temp", { catalog, kind: "source" }); // source hits
  for (const row of rows) {
    if (row.kind === "station") { row.timezone; }         // narrows to station geo
    else { row.availability; }                            // narrows to source meta
  }

loadWeatherCatalog()

loadWeatherCatalog(url): Promise<readonly CatalogEntry[]>

Lazily fetch a per-domain catalog manifest (browser-safe: fetch + JSON). Point url at the committed @mostlyrightmd/weather/catalog asset. Kept out of the barrel’s top level so the manifest never enters the size-budgeted meta bundle.

Parameters

url

string

Returns

Promise<readonly CatalogEntry[]>

trainingTable()

trainingTable(station, fromDate, toDate, opts): Promise<DataResult<TrainingTableRow>>

A built-in supervised-table example: features -> label rows for a station + date window, one per station local standard day. It preserves the recipe’s temporal columns and applies the timing metadata available from its sources.

An omitted label returns the "daily_summary" settlement target (Kalshi NHIGH/NLOW ground truth) beside the observation feature aggregates. Pass label: "daily_extremes" to swap in the Polymarket WU/NOAA-WRH target.

Parameters

station

string

the station id (e.g. "KNYC").

fromDate

string

YYYY-MM-DD inclusive start.

toDate

string

YYYY-MM-DD inclusive end.

opts

TrainingTableOptions = {}

the accepted options — only label.

Returns

Promise<DataResult<TrainingTableRow>>

a DataResult of TrainingTableRow plus its provenance envelope.

Example

const { rows, provenance } = await trainingTable("KNYC", fromDate, toDate);