Rename capgen-ng to capgen

Author: climbfuji

.github/workflows/end-to-end-tests.yaml

@@ -1,4 +1,4 @@
-name: capgen-ng end-to-end tests
+name: capgen end-to-end tests
 
 on:
   workflow_dispatch:

.github/workflows/unit-tests.yaml

@@ -1,4 +1,4 @@
-name: capgen-ng unit tests
+name: capgen unit tests
 
 on:
   workflow_dispatch:
@@ -12,7 +12,7 @@ concurrency:
 jobs:
 
   unit-tests:
-    name: capgen-ng unit tests
+    name: capgen unit tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -40,9 +40,9 @@ jobs:
         which xmllint
         xmllint --version
         which pytest
-    - name: Run capgen-ng unit tests
+    - name: Run capgen unit tests
       run: |
         pytest -v unit-tests/
-    - name: Run capgen-ng module doctests
+    - name: Run capgen module doctests
       run: |
-        PYTHONPATH=capgen-ng pytest --doctest-modules capgen-ng
+        PYTHONPATH=capgen pytest --doctest-modules capgen

capgen-ng/__init__.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-"""ccpp_capgen_ng — next-generation CCPP cap code generator.
+"""ccpp_capgen — next-generation CCPP cap code generator.
 
 This script replaces both ``ccpp_prebuild.py`` and ``ccpp_capgen.py`` from the
 legacy toolchain.  It reads host-model metadata files, scheme metadata files,
@@ -20,7 +20,7 @@
 -----
 ::
 
-    ccpp_capgen_ng.py \\
+    ccpp_capgen.py \\
         --host-name    <name> \\
         --host-files   <f1.meta,f2.meta,...> \\
         --scheme-files <f1.meta,f2.meta,...> \\
@@ -75,7 +75,7 @@
 import sys
 from typing import Dict, List, Optional, Tuple
 
-# Ensure the capgen-ng package is importable when invoked directly.
+# Ensure the capgen package is importable when invoked directly.
 _SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 _PACKAGE_DIR = os.path.dirname(_SCRIPT_DIR)
 if _PACKAGE_DIR not in sys.path:
@@ -106,7 +106,7 @@
 # Logging
 ########################################################################
 
-_LOGGER = init_log('ccpp_capgen_ng')
+_LOGGER = init_log('ccpp_capgen')
 
 
 ########################################################################
@@ -125,8 +125,8 @@
 # generated cap modules whenever any suite touches constituent state.
 # Listed in datatable.xml's <utilities> so host CMake projects pick them
 # up via ccpp_datafile.py --utility-files / --ccpp-files queries.  All
-# of these live in :data:`_FRAMEWORK_SRC_DIR` (capgen-ng's own ``src/``);
-# capgen-ng ships self-contained — no external src/ companion needed.
+# of these live in :data:`_FRAMEWORK_SRC_DIR` (capgen's own ``src/``);
+# capgen ships self-contained — no external src/ companion needed.
 _FRAMEWORK_F90_FILES = [
     'ccpp_constituent_prop_mod.F90',
     'ccpp_hashable.F90',
@@ -139,8 +139,8 @@ def _resolve_framework_f90_files() -> List[str]:
     """Return absolute paths for the framework F90 files.
 
     Each name in :data:`_FRAMEWORK_F90_FILES` is looked up under
-    :data:`_FRAMEWORK_SRC_DIR` (``capgen-ng/src/``).  A missing file is
-    a hard error: capgen-ng/src/ is the canonical (and only) location;
+    :data:`_FRAMEWORK_SRC_DIR` (``capgen/src/``).  A missing file is
+    a hard error: capgen/src/ is the canonical (and only) location;
     a missing file means the deployment is incomplete and the host
     build would fail later with an opaque "Cannot open module file"
     error.  Surface it now with a precise message instead.
@@ -155,10 +155,10 @@ def _resolve_framework_f90_files() -> List[str]:
             missing.append(p)
     if missing:
         raise CCPPError(
-            "capgen-ng deployment is incomplete: required framework "
+            "capgen deployment is incomplete: required framework "
             "Fortran source file(s) not found under {!r}:\n  {}\n"
-            "Vendor the missing file(s) into capgen-ng/src/ (the "
-            "canonical location for files capgen-ng emits a USE for).".format(
+            "Vendor the missing file(s) into capgen/src/ (the "
+            "canonical location for files capgen emits a USE for).".format(
                 _FRAMEWORK_SRC_DIR, '\n  '.join(missing),
             )
         )
@@ -177,7 +177,7 @@ def _build_arg_parser() -> argparse.ArgumentParser:
     argparse.ArgumentParser
     """
     parser = argparse.ArgumentParser(
-        prog='ccpp_capgen_ng.py',
+        prog='ccpp_capgen.py',
         description='CCPP next-generation cap code generator',
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog=__doc__,
@@ -253,7 +253,7 @@ def _build_arg_parser() -> argparse.ArgumentParser:
             "TRANSIENT MIGRATION SHIM.  Accept legacy CCPP standard "
             "names (currently 'horizontal_loop_extent') in scheme "
             "metadata and silently rewrite them to their canonical "
-            "capgen-ng equivalents ('horizontal_dimension').  Emits a "
+            "capgen equivalents ('horizontal_dimension').  Emits a "
             "loud warning at startup.  Will be removed."
         ),
     )
@@ -718,7 +718,7 @@ def _load_metadata_files(
 #     ``number_of_threads`` is carried as a control dummy (the framework owns
 #     no per-thread state yet, so its value is not consumed — kept for symmetry
 #     with ``number_of_instances`` and future per-thread sizing).
-# (A chunk/block index is intentionally NOT a control pair: capgen-ng's
+# (A chunk/block index is intentionally NOT a control pair: capgen's
 # slice-based design passes the current chunk as a horizontal range via
 # horizontal_loop_begin/end, so no scheme ever indexes by chunk inside a call.)
 # Each entry: (index std_name, count std_name, index description, count description).

capgen-ng/generator/__init__.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-"""Query CLI for the ``datatable.xml`` produced by ``ccpp_capgen_ng.py``.
+"""Query CLI for the ``datatable.xml`` produced by ``ccpp_capgen.py``.
 
 This is the read-side companion to :mod:`generator.datatable`.  The writer
 half lives in the generator package; this module is a pure-Python,
@@ -24,15 +24,15 @@
 
 Exactly one report action is required per invocation.
 
-Notes specific to capgen-ng
+Notes specific to capgen
 ---------------------------
 * ``--host-files`` returns ``<host>_ccpp_cap.F90`` (the per-host static API;
   filename and module name derived from ``--host-name`` at generation time).
 * ``--capgen-files`` enumerates Fortran sources only.  Non-Fortran inspection
   artifacts (``ccpp_<suite>.meta``, ``ccpp_<suite>_expanded.xml``) are
   reported via ``--inspection-files``.
 * ``--process-list`` is supported syntactically but will return an empty
-  string: capgen-ng does not currently record a ``process`` attribute on
+  string: capgen does not currently record a ``process`` attribute on
   scheme entries.
 """
 
@@ -167,7 +167,7 @@ def valid_actions(cls):
 def _command_line_parser():
     """Create and return an ArgumentParser for parsing the command line."""
     description = """
-    Retrieve information about a ccpp_capgen_ng run.
+    Retrieve information about a ccpp_capgen run.
     The returned information is controlled by selecting an action from
     the list of optional arguments below.
     Note that exactly one action is required.
@@ -297,7 +297,7 @@ def _retrieve_scheme_files(table):
     (or ``.F`` / ``.f90`` / ``.f``) sources for schemes that the loaded
     suites actually reference.  Build systems use this to compile exactly
     the scheme set the suites consume; unreferenced scheme metadata
-    files passed on the capgen-ng CLI for convenience are filtered out.
+    files passed on the capgen CLI for convenience are filtered out.
 
     # Test valid scheme files
     >>> table = ET.fromstring("<ccpp_datatable version='1.0'><scheme_files>"\
@@ -345,7 +345,7 @@ def _retrieve_scheme_files(table):
 def _retrieve_inspection_files(table, file_type=None):
     """Find and retrieve a list of inspection filenames from <table>.
 
-    Inspection files are non-Fortran artifacts emitted by capgen-ng for
+    Inspection files are non-Fortran artifacts emitted by capgen for
     debugging and downstream tooling: suite ``.meta`` files and expanded
     suite-definition XML.  Each kind lives in its own subsection of
     ``<inspection_files>``.
@@ -390,7 +390,7 @@ def _retrieve_inspection_files(table, file_type=None):
 def _retrieve_process_list(table):
     """Find and return a list of all physics scheme processes in <table>.
 
-    capgen-ng does not currently record a ``process`` attribute on
+    capgen does not currently record a ``process`` attribute on
     scheme entries, so this returns an empty list when no scheme carries
     one.  The flag is kept for CLI compatibility.
 

capgen-ng/metadata/__init__.py

@@ -59,7 +59,7 @@
 import sys
 from typing import Dict, List, NamedTuple, Optional, Set, Tuple
 
-# Ensure the capgen-ng package is importable when invoked directly.
+# Ensure the capgen package is importable when invoked directly.
 _SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 _PACKAGE_DIR = os.path.dirname(_SCRIPT_DIR)
 if _PACKAGE_DIR not in sys.path:
@@ -1750,15 +1750,15 @@ def _build_parser() -> argparse.ArgumentParser:
             "TRANSIENT MIGRATION SHIM.  Accept legacy CCPP standard "
             "names (currently 'horizontal_loop_extent') in scheme "
             "metadata and silently rewrite them to their canonical "
-            "capgen-ng equivalents ('horizontal_dimension').  Emits a "
+            "capgen equivalents ('horizontal_dimension').  Emits a "
             "loud warning at startup.  Will be removed."
         ),
     )
     # NB: --gfs-dim-aliases is NOT exposed here.  That shim only takes
     # effect inside generator.suite_resolver._canonical_dim, which the
     # validator never invokes (the validator compares metadata against
     # Fortran source, not host metadata against scheme metadata), so
-    # the flag would be a no-op.  See capgen-ng/ccpp_capgen_ng.py.
+    # the flag would be a no-op.  See capgen/ccpp_capgen.py.
     # auto-clone-constituents: transient legacy shim.  This one DOES
     # belong on the validator because the shim extends the parser's
     # ``_KNOWN_ATTRS`` set — without the flag the validator rejects
@@ -1774,7 +1774,7 @@ def _build_parser() -> argparse.ArgumentParser:
             "TRANSIENT LEGACY SHIM.  Accept four legacy constituent "
             "attributes (default_value, min_value, water_species, "
             "mixing_ratio_type) on scheme args.  Mirrors the same "
-            "flag on ccpp_capgen_ng so legacy scheme metadata that "
+            "flag on ccpp_capgen so legacy scheme metadata that "
             "needs auto-clone-static-constituent codegen can be "
             "validated against its Fortran source.  Emits a loud "
             "warning at startup.  Will be removed."

capgen-ng/ccpp_capgen_ng.py capgen/ccpp_capgen.pycapgen-ng/ccpp_capgen_ng.py renamed to capgen/ccpp_capgen.py

@@ -0,0 +1 @@
+"""Cap code generation for ccpp-capgen."""

capgen-ng/ccpp_datafile.py capgen/ccpp_datafile.pycapgen-ng/ccpp_datafile.py renamed to capgen/ccpp_datafile.py

@@ -6,7 +6,7 @@
 XML layout
 ----------
 
-Two top-level file sections partition capgen-ng's outputs by language:
+Two top-level file sections partition capgen's outputs by language:
 
 * ``<capgen_files>`` lists *Fortran sources only* — utilities, the host-facing
   API, and per-suite cap modules.  All paths here end in ``.F90`` and are
@@ -129,13 +129,13 @@ def _build_capgen_files(
 ) -> None:
     """Append ``<capgen_files>`` to *root*.
 
-    ``<capgen_files>`` lists Fortran sources generated by capgen-ng (utilities,
+    ``<capgen_files>`` lists Fortran sources generated by capgen (utilities,
     the host-facing API, and per-suite caps).  Non-Fortran inspection
     artifacts (e.g. ``.meta`` files, expanded SDFs) live in
     ``<inspection_files>`` and are emitted by :func:`_build_inspection_files`.
 
     ``host_file_paths`` lists files generated for the host-facing API.  In
-    capgen-ng this is the static API (``<host>_ccpp_cap.F90``); the section is
+    capgen this is the static API (``<host>_ccpp_cap.F90``); the section is
     emitted unconditionally (possibly empty) to keep the schema stable.
     """
     capgen_files = ET.SubElement(root, 'capgen_files')
@@ -164,7 +164,7 @@ def _build_scheme_files(
 
     Lists the Fortran source files of schemes actually referenced by some
     loaded suite (group phase calls + suite-level ``<init>`` / ``<final>``).
-    These files are *not* generated by capgen-ng — they are the
+    These files are *not* generated by capgen — they are the
     user-supplied scheme implementations the build system must compile.
     The section is always written (possibly empty) so the schema stays
     stable for ``ccpp_datafile.py`` consumers.
@@ -182,7 +182,7 @@ def _build_inspection_files(
 ) -> None:
     """Append ``<inspection_files>`` to *root*.
 
-    Inspection artifacts are non-Fortran outputs that capgen-ng emits for
+    Inspection artifacts are non-Fortran outputs that capgen emits for
     debugging and downstream tooling.  They are *not* compiled.  Each kind
     of artifact lives in its own subsection so consumers can pick a specific
     file type or take them all together via ``--inspection-files``.
@@ -400,7 +400,7 @@ def write_datatable(
     output_root : str
         Output directory.
     host_file_paths : list of str, optional
-        Absolute paths to host-facing API files (capgen-ng emits
+        Absolute paths to host-facing API files (capgen emits
         ``<host>_ccpp_cap.F90`` here).  The ``<host_files>`` section is
         always written (possibly empty).
     scheme_file_paths : list of str, optional