Repository navigation
docs(units): document units at PyNEATS I/O boundaries and add units a… - #69
Merged
Merged
Conversation
…udit Documentation-only patch: comments and docstrings, no code changes (verified by an AST comparison of every touched file against HEAD). - State the unit and convention of every AO upload field at the JSON boundary (neats_io), the Flight4D view, NEATSFuel, the default constants, the BADA performance model, the climate functions and the GWP outputs. - Document the two interface differences handled upstream by the NEATS application: tas knots -> m/s and calorific_value MJ/kg -> J/kg. PyNEATS expects m/s and J/kg. - Cite MRR Annex IIIa (Reg. (EU) 2018/2066 as amended by 2024/2493) for ff (whole aircraft), ee (overall propulsion efficiency), load_factor (payload / maximum payload), H/C (atomic) and take-off mass. - Correct comments that contradicted the code: FL15 vs FL20, the 1.1 vs 1.2 guardrail, the mass-derived fuel-flow difference, the no-op parser timezone, the "automatic unit conversions" claim, the BADA3 MPL note, the REFERENCE_Q_FUEL origin, the 500 vs 550 hPa default, the performance-runner timestamp example and to_dict rounding. - Add docs/internal/pyneats_units_audit.md: audit tables for every AO input field and public output, the regulatory definitions, new discrepancies (e.g. PV in SI where the local aCCF H2O regression expects PVU; Method D contrails_ef_J holding an AGWP; OpenAirClim nox = "NO" for NO2-equivalent input; t_0 pinned to 2025) and open questions. No discrepancy is fixed here. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Units audit of PyNEATS against the AO upload schema, plus unit documentation in code.
No behaviour change: comments, docstrings and one new document only.
docs/internal/pyneats_units_audit.md: field-by-field audit of AO inputs and publicoutputs, regulatory definitions (MRR Annex IIIa), and the list of discrepancies found
(D1–D4, O1–O16, A1–A13, I1–I8). Follow-up fixes will each update this report.
emissions, climate, runners, weather), including the two conversions done upstream by
the NEATS application (tas knots→m/s, calorific_value MJ/kg→J/kg).
Why it is safe
.pyfile the AST with docstringsremoved equals v1.0.1 (27/27 files).
ruff check,ruff format --check,mypy src/pyneats/: clean.Review notes
Docs-only. The findings themselves are discussed issue by issue in follow-up PRs;
numbers-changing fixes will come separately, each with its own evidence.