digitalmodel/specs/module-registry.yaml

import yaml
from pathlib import Path

REGISTRY = Path("digitalmodel/specs/module-registry.yaml")

def find_by_capability(keyword: str) -> list[dict]:
    """Return all modules whose capabilities mention the keyword."""
    data = yaml.safe_load(REGISTRY.read_text())
    keyword = keyword.lower()
    return [
        m for m in data["modules"]
        if any(keyword in cap.lower() for cap in m.get("capabilities", []))
        or keyword in m.get("description", "").lower()
    ]

# Examples
find_by_capability("cathodic protection")
find_by_capability("rainflow")
find_by_capability("plate buckling")
find_by_capability("wall thickness")

def find_by_standard(standard_id: str) -> list[dict]:
    """Return modules that reference a standard, with implementation status."""
    data = yaml.safe_load(REGISTRY.read_text())
    standard_id = standard_id.upper()
    results = []
    for m in data["modules"]:
        for std in m.get("standards", []):
            if standard_id in std["id"].upper():
                results.append({
                    "module_id": m["id"],
                    "path": m["path"],
                    "status": std["status"],
                    "maturity": m["maturity"],
                    "description": m["description"],
                })
    return results

# Examples
find_by_standard("DNV-ST-F101")
find_by_standard("API-579")
find_by_standard("BS-7910")
find_by_standard("DNVGL-RP-C203")

def find_by_maturity(level: str) -> list[dict]:
    """Return all modules at a given maturity level.

    level: 'production' | 'stable' | 'beta' | 'stub'
    """
    data = yaml.safe_load(REGISTRY.read_text())
    return [m for m in data["modules"] if m.get("maturity") == level]

find_by_maturity("production")

def get_module(module_id: str) -> dict | None:
    """Retrieve full module record by id (e.g. 'structural/fatigue')."""
    data = yaml.safe_load(REGISTRY.read_text())
    for m in data["modules"]:
        if m["id"] == module_id:
            return m
    return None

get_module("asset_integrity")
get_module("hydrodynamics/diffraction")

def modules_with_gaps() -> list[dict]:
    """Return modules that have documented capability gaps."""
    data = yaml.safe_load(REGISTRY.read_text())
    return [m for m in data["modules"] if m.get("gaps")]

Load digitalmodel/specs/module-registry.yaml and search capabilities/description
for "<X>". Return module id, path, maturity, and relevant capabilities.

Load digitalmodel/specs/module-registry.yaml and search standards[].id for "<Y>".
Return module id, path, implementation status, and any documented gaps.

1. Call find_by_capability("<Z keyword>") on the registry.
2. Filter to maturity in [production, stable].
3. Return top 3 results with id, path, capabilities, and inputs/outputs.

bash scripts/readiness/query-docs.sh --capability "cathodic protection"
bash scripts/readiness/query-docs.sh --standard "DNV-ST-F101"