docs(policy): expand off-limits sources list (#173)#199
Merged
Conversation
Extends `docs/data-policy.md` with the items from #173 that weren't covered by the initial #174 sweep: - MMPDS-02+ (commercial successor to MIL-HDBK-5J) — important to call out separately so the MIL-HDBK-5J PD-USGov path (#166) isn't conflated with later proprietary revisions - Vendor scintillator/laminate datasheets (Saint-Gobain/Luxium, Eljen, Furukawa, C&A, Kuraray, Rogers, Isola) — explicit list so scintillator-catalog PRs (#142-147) don't have to relitigate - CIE booklets — paired with the colour-science (BSD-3) replacement - Paywalled academic papers — DOI citation OK; figure/table embed not Adds a "Rule of thumb" section codifying the fact-extraction vs table-copying line per the Feist/EU-sui-generis framing already in the doc. No code changes; closes #173.
6 tasks
6 tasks
gerchowl
added a commit
that referenced
this pull request
May 6, 2026
Cite-only attachment of MIL-HDBK-5J (2003, PD-USGov) primary tables to existing aerospace alloy entries in metals.toml, per #166. No new materials, no new property fields, no temperature curves — single room-temperature design values only, with verified page numbers. Per-property `_sources` entries added (license="PD-USGov"): - stainless.s17_4PH (H900 condition, sheet/strip/plate, S-basis): density, tensile_strength (190 ksi=1310 MPa), yield_strength (170 ksi=1172 MPa). Table 2.6.9.0(b), p.2-197. - titanium.grade5 (Ti-6Al-4V bar AMS 4928, annealed, S-basis): density (0.160 lb/in^3=4.428 g/cm^3), tensile_strength (135 ksi=931 MPa, TOML 950 = conventional rounding), yield_strength (125 ksi=862 MPa, TOML 880 = same). Table 5.4.1.0(c1), p.5-54. - aluminum.a2024 (sheet/plate AMS 4037, T3/T351): density only (0.100 lb/in^3=2.768 g/cm^3). Table 3.2.3.0(b1), p.3-69. - aluminum.a7075 (sheet/plate AMS 4045, T6/T62): density (0.101 lb/in^3=2.796 g/cm^3) and youngs_modulus (10.3e3 ksi=71.0 GPa). Table 3.7.6.0(b1), p.3-371. UTS/yield citations were NOT attached for 6061-T6, 7075-T6, 7075-T73, or 2024 strength fields because the existing TOML values are typical or AMS-minimum datasheet numbers, not MIL-HDBK-5J A/B-basis design allowables (off by 5-15%). Adding a misleading citation would be a bug; per #166's "never invent a value" rule, those properties retain the `_default` placeholder until a future PR aligns the values to a specific MIL-HDBK-5J table cell or cites a different primary source. Out of scope (no existing TOML entries — Phase 5 territory per #166): 15-5PH stainless, Inconel 625/718, magnesium AZ91, beryllium. MMPDS-02+ off-limits status confirmed in docs/data-policy.md (lines 97-99, added in #199/PR #202); no edit needed. Page numbers verified 2026-05-07 against the official MIL-HDBK-5J PDF (everyspec.com, MILHBK5J.pdf, 1733 pp.) — section numbers and page numbers cross-checked against both the ToC and the actual section bodies, since several sections shifted between MIL-HDBK-5H (1998) and MIL-HDBK-5J (2003). Notably 5J's section 2.6.9 is 17-4PH and 2.6.7 is 15-5PH, while 5H assigned them differently. Validation: TOML parses, license gate passes, tests/test_sources.py + tests/test_toml_integrity.py pass, full suite 691 passed/18 skipped, ruff clean. Closes #166.
7 tasks
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
docs/data-policy.mdoff-limits section with MMPDS-02+, vendor scintillator/laminate datasheets, CIE booklets, and paywalled academic papers — items called out in Off-limits sources — document in CONTRIBUTING.md #173 but not covered by the initial Data-licensing policy: add docs/data-policy.md + CONTRIBUTING update #174 policy sweep.Closes #173.
Test plan
uv run pytest— 654 passed (no code changed; sanity check only)docs/data-policy.mdrenders cleanly in GitHub markdown preview