Adopt nomad-sim-parser mapping-report format for parser FEATURES.yml - #341
Merged
Conversation
Replace the free-form, LLM-authored `FEATURES.yml` capability files with per-parser `MAPPING_REPORT.md` files that mirror the programmatic mapping report of the new-schema simulation parsers (nomad-parser-plugins-simulation, `nomad-sim-parser mapping-report`). Each report has one section per declarative file-parser class, listing every declared `Quantity` with its mapping status (Mapped/Unmapped) and, when mapped, the runschema attribute it feeds, plus a per-section coverage percentage. This turns a prose capability list into a concrete, source-traceable coverage view and exposes where extraction lands only in code-specific `x_<code>_*` metainfo. - Rewrite `.github/copilot-instructions.md`: Markdown mapping-report format, deterministic generation recipe, grep-based self-check in place of the old `source:` convention, dynamically-named quantities explicitly in scope. - Convert all 42 in-repo parsers (molpro excluded: it is a submodule). - Add `docs/reference/parser_mapping_report.md`, the concatenation of the per-parser fragments (rebuilt by hand, no build tooling). Parsers with no declarative `Quantity` list (custom archive-writing logic) are marked "Coverage: Not available" rather than given a fabricated number.
Collaborator
|
I do not mind really having this, but considering that we will not anymore further develop the parsers here, I do not see much value. But can be merged, I guess. |
Contributor
Author
The value proposition is simple: this will help us, and in particular Cecilia and Ksenia, more easily compare parser coverage between old and new. |
Coverage Report for CI Build 34338698084Coverage remained the same at 92.855%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
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
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.
Purpose
The parser capability files (
FEATURES.yml) were free-form, LLM-authored prose,guarded only by a
source:convention that nothing enforced. This PR reshapes theminto per-parser
MAPPING_REPORT.mdfiles that mirror the programmatic mappingreport of the new-schema simulation parsers (
nomad-parser-plugins-simulation,nomad-sim-parser mapping-report), giving a concrete, source-traceable view of whichdeclarative file-parser quantities reach the normalized runschema — and where coverage
is missing.
Scope
Included
.github/copilot-instructions.md: Markdown mapping-report format (one sectionper file-parser class:
File-parser quantity | Status | Archive mapper source+ acoverage %), a deterministic generation recipe, a grep-based self-check replacing the
old
source:field, and explicit handling of dynamically-named quantities.FEATURES.yml→MAPPING_REPORT.md, regenerated fromparser source.
docs/reference/parser_mapping_report.md, the concatenation of the fragments.Out of scope
molpro— it is a git submodule (nomad-parser-molpro-plugin); its report must beconverted in that repo.
(review-based trust), matching the existing LLM-authored workflow.
Context & Links
FAIRmat-NFDI/nomad-parser-plugins-simulationPR Update hdf5 references #214 (parsercoverage report) by @ladinesa.
FEATURES.ymlconvention introduced in Add parser coverage AI #321/Add FEATURES.yml documentation for Wannier90, Gaussian, ORCA, ABINIT, and Wien2k parsers #323/Update all FEATURES.yml files with source field compliance #324.Reviewer Notes
(yambo, wien2k, orca, abacus) reflect heavy
x_<code>_*-only extraction, not missingwork. Eight parsers with custom archive-writing and no declarative
Quantitylist aremarked "Coverage: Not available" rather than given a fabricated number.
against source), not machine-computed — please sanity-check spot cases. Regeneration
found several latent parser bugs (e.g. elk
energy_chagetypo, mopacn_fillednamemismatch, psi4 corrupted quantity name); these are documented as Unmapped, not fixed
here.
Status
Breaking Changes
Dependencies / Blockers
Testing / Validation
to a real
Quantitydeclaration and per-section summary counts/coverage match thetables; combined report regenerated by concatenation.