docs(data): primary-paper citations for scintillator entries (#170)#202
Merged
Conversation
Replace the #175 audit-window `_default` placeholders on lyso/bgo/nai/csi/ labr3/pwo with verified primary measurement papers (DOIs confirmed via Crossref). Vendor- and grade-specific entries (Saint-Gobain, Hamamatsu, Eljen, SICCAS, Epic, plastic_scint catalogue) keep `_default` since primary papers don't constrain vendor variants. The LBNL Scintillator Library (https://scintillator.lbl.gov/) was used as a discovery index per the issue, never cited as a `_sources.ref`. The LBNL group's own database overview (Shook, Laplace et al. 2025, NIM A) is attached as `optical._review` for the modern materials it covers. CsI:Na keeps `_default` — Holl 1988 covered CsI(Tl), not CsI(Na). TODO documented inline. Closes #170.
The typos hook was rewriting every "LSO" to "ALSO" in the #170 scintillator citations. LSO is the historical parent of LYSO (Lu2SiO5) and a load-bearing acronym in scintillator literature.
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
Cite-only attachment of primary measurement papers to scintillator
_sourcesblocks, per #170. The LBNL Scintillator Library (https://scintillator.lbl.gov/) was used as a discovery index — papers it cites were verified via Crossref and attached as_sources.refDOIs. The LBNL site itself is never cited as a source. The LBNL group's own database overview (Shook, Laplace, Boswell, Bourret, Derenzo, Goldblum 2025, NIM A) is attached asoptical._reviewfor the modern materials it covers.No property values, schema, or runtime code were touched. Vendor- and grade-specific entries retain the
_defaultplaceholder where primary papers don't constrain vendor variants.Per-material citations attached (DOIs verified via Crossref)
lyso(LSO)10.1109/23.159655lyso.Ce(LYSO:Ce)10.1063/1.1328775bgo10.1063/1.1662183nai,nai.Tl10.1103/PhysRev.74.100csi,csi.Tl10.1109/23.12684labr310.1063/1.1385342pwo10.1016/0168-9002(93)91187-R10.1016/j.nima.2025.170389Notes on the issue's DOI hint
10.1016/j.nima.2024.169742for "Laplace et al. 2024, NIM A". That DOI resolves (via Crossref) to a different paper — Zhang et al. 2024, "Conceptual design of a gamma-to-electron energy-selective imaging system" (NIM A 1068). The actual LBNL Scintillator Library overview paper from this group is Shook, Laplace et al. 2025, NIM A 1075, 170389 (DOI10.1016/j.nima.2025.170389); Laplace is second author. Cited under the verified DOI accordingly. Per spec ("never invent a DOI"), the unverified hint was discarded.https://escholarship.org/uc/item/4rx6b1k3is bot-blocked behind CloudFront WAF, so verification fell back to Crossref metadata for the published version, which is canonical.Materials NOT attached (placeholder retained)
csi.Nalyso.Ce.saint_gobain(+ prelude420),lyso.Ce.epic,lyso.Ce.siccasnai.Tl.saint_gobain,nai.Tl.hamamatsuplastic_scint,plastic_scint.BC400,plastic_scint.EJ200The 6 modern scintillators in the issue list that are not in this TOML (GAGG, CeBr3, SrI2, LSO-as-distinct-from-LYSO) were out of scope per the "do NOT add new materials" rule. The verified primary-paper DOIs for those (Kamada 2011 GAGG
10.1021/cg200694a; Shah 2005 CeBr3 IEEE TNS 52(6) 3157; Cherepy 2008 SrI2:Eu APL10.1063/1.2885728) are documented here for future reference when those materials land.Test plan
python -c "import tomllib; tomllib.loads(open('src/pymat/data/scintillators.toml').read())"— TOML parsespython scripts/check_licenses.py— license gate passes (7 TOML files scanned)uv run python -m pytest tests/test_toml_integrity.py tests/test_sources.py -v— 43 passeduv run python -m pytest— 628 passed, 22 skippeduv run ruff check . && uv run ruff format --check .— cleanCloses #170.