Skip to content

feat: enhance grammar specification and documentation system#14

Merged
Simon-McIntosh merged 13 commits intoiterorganization:mainfrom
Simon-McIntosh:main
Nov 20, 2025
Merged

feat: enhance grammar specification and documentation system#14
Simon-McIntosh merged 13 commits intoiterorganization:mainfrom
Simon-McIntosh:main

Conversation

@Simon-McIntosh
Copy link
Copy Markdown
Collaborator

This major update establishes a more robust foundation for IMAS standard names with enhanced validation and comprehensive documentation generation.

Key Changes

Grammar System Enhancements

  • Add comprehensive grammar specification with detailed field schemas and validation rules
  • Introduce generic_physical_bases vocabulary to prevent ambiguous names
  • Modernize codebase structure and validation logic
  • Improve grammar reference documentation generation

Documentation Improvements

  • Enhance documentation requirements with inline links, equations, and formatting standards
  • Update development guidelines and agent documentation
  • Add new documentation files for metadata conventions, schema tool redesign, and tokamak parameters

New Features

  • Add tokamak parameters and vocabulary management tools
  • Implement new MCP tools for grammar, vocabulary management, and standard name listing
  • Add support for 12+ tokamak devices (ITER, JET, EAST, KSTAR, etc.)

Code Quality

  • Update project configuration with new dependencies and development tools
  • Modernize tool structure and remove deprecated components
  • Comprehensive test coverage for new functionality

Files Changed

  • 185 files modified
  • 15,704 insertions, 3,811 deletions
  • Major refactoring of grammar, tools, and validation systems

Breaking Changes

  • Tool reorganization (some tools renamed/moved)
  • Enhanced validation rules may reject previously valid names
  • Updated vocabulary structure

This update provides the foundation for more robust standard name validation and management while maintaining backward compatibility for existing valid names.

- Add comprehensive grammar specification with detailed field schemas and validation rules
- Introduce generic_physical_bases vocabulary to prevent ambiguous names
- Enhance documentation requirements with inline links, equations, and formatting standards
- Update project configuration with new dependencies and development tools
- Improve grammar reference documentation generation
- Modernize codebase structure and validation logic
- Add tokamak parameters and vocabulary management tools
- Update development guidelines and agent documentation

This major update establishes a more robust foundation for IMAS standard names
with enhanced validation, and comprehensive documentation generation.
- Regenerate constants and schemas
- Add description validation
- Update AGENTS.md documentation
…vocation and remove generated files from version control.
…vocation and remove generated files from version control.
@codecov-commenter
Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@Simon-McIntosh Simon-McIntosh merged commit f7475df into iterorganization:main Nov 20, 2025
5 checks passed
Simon-McIntosh added a commit that referenced this pull request Apr 28, 2026
Compose-level NC-32 patch in imas-codex (47ed76eb) prevented new
_on_ggd compositions, but the vocab attach pipeline kept resurfacing
pre-existing registry entries with this suffix. W25D + W26B evidence:
13 attach-through names scoring 0.5-0.6 dragged MHD domain mean to
0.645 (YELLOW boundary).

Standard names should be coordinate-system agnostic. The DD ggd/*
path subtree encodes coordinate metadata at the schema level, not the
physics name level.

This PR retires the _on_ggd suffix family by:
- Deleting 4 physical bases with canonical non-GGD twins:
  energy_radial_diffusivity_on_ggd (twin: energy_radial_diffusivity)
  momentum_diffusivity_on_ggd (twin: momentum_diffusivity)
  momentum_radial_diffusivity_on_ggd (twin: momentum_radial_diffusivity)
  particle_radial_diffusivity_on_ggd (twin: particle_radial_diffusivity)
- Deleting on_ggd unary postfix operator from operators.yml
- Regenerating model_types.py and constants.py (ON_GGD enum removed)
- Updating test expectations (2 parametrized entries removed)

All 1106 tests pass. Zero test count delta (removed 2 parametrized
entries, no new tests needed since canonical twins remain).

Cross-references:
- imas-codex commit 47ed76eb (NC-32 compose-level prohibition)
- W26B verdict report (this PR motivation)
- W25D MHD domain rotation evidence
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.

2 participants