Skip to content

docs: correct pages made stale by #79 and #81 and describe the real output (D-a) - #88

Merged
ramondalmau merged 1 commit into
devfrom
docs/fix-stale-docs
Oct 28, 2026
Merged

ramondalmau merged 1 commit into
devfrom
docs/fix-stale-docs

Conversation

@ramondalmau

Copy link
Copy Markdown
Collaborator

Text only; no code or behaviour change.

  • Empty AO values (fix(interpolation): skip empty values in operator columns when resampling (audit D4) #81): mrv-specification.md and input-prioritization.md said an empty
    value empties its neighbours and drops out of the fuel totals. It is interpolated in time
    between the nearest points with a value, as input-format.md already says.
  • Fuel flow derived from the AO mass (fix(performance): fuel flow derived from aircraft_mass is no longer one point late #79): describe the current formula (mass decrease to the
    next point / time to the next point).
  • output-format.md rewritten around runner.results: success entries, low-altitude zero
    results and error records (order, keys, examples that run), fleet_meta_data keys from
    report.py, bada_version / bada_code absent on the AO fuel flow + efficiency + mass path,
    multi-engine entries (DataFrame input with a list engine_uid is not supported: tracked as
    DF-ME). The per-segment field list moves to a "Golden dump" section.
  • flight_schema.json, description strings only: hydrogen content wt.%, calorific value
    J/kg, departure/arrival times as supplied, EDB engine UID, load factor basis, whole-aircraft
    fuel flow, propulsion efficiency, flight level, TAS in m/s (AO sends knots).
  • usage.md: working ZarrPaths and DWDFactory snippets. examples/README.md and
    example-scripts.md: units and the efficiency definition.
  • For Philippe: EAGWP/AGWP units in the MRV formulas corrected from [W m-2] to
    [W m-2 yr]; hydrogen content formula now gives wt.% (x 100).

Checks. Reviewed by independent checkers over 5 rounds against the code; every code example
in output-format.md and the changed usage.md snippets were run. Schema still valid; the 11
golden inputs still validate against it. Non-weather suite: 407 passed.

Still to do (D-b): input-format.md field definitions from the AO schema.

Review. Ramon; Philippe for the two formula changes.

…utput (D-a)

Text only; no code or behaviour change.

- Empty AO values (#81): mrv-specification.md and input-prioritization.md
  said an empty value empties its neighbours and drops out of the fuel
  totals. It is interpolated in time between the nearest points with a
  value, as input-format.md already says.
- Fuel flow derived from the AO mass (#79): describe the current formula
  (mass decrease to the next point / time to the next point).
- output-format.md rewritten around runner.results: success entries,
  low-altitude zero results and error records (order, keys, examples that
  run), fleet_meta_data keys from report.py, bada_version / bada_code absent
  on the AO fuel flow + efficiency + mass path, multi-engine entries. The
  per-segment field list moves to a "Golden dump" section.
- flight_schema.json: description strings only (hydrogen content wt.%,
  calorific value J/kg, departure/arrival times as supplied, EDB engine UID,
  load factor basis, whole-aircraft fuel flow, propulsion efficiency, flight
  level, TAS in m/s).
- usage.md: working ZarrPaths and DWDFactory snippets; examples/README.md and
  example-scripts.md: units and the efficiency definition; EAGWP units
  W m-2 yr in the MRV formulas; hydrogen content formula in wt.%.

Checked by independent reviewers over 5 rounds against the code on dev;
every code example in output-format.md and the changed usage.md snippets
were run.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@ramondalmau
ramondalmau merged commit d7bf2da into dev Oct 28, 2026
2 checks passed
@ramondalmau
ramondalmau deleted the docs/fix-stale-docs branch October 28, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant