Quality of life improvements for MFC toolchain #1118

cubic-dev-ai · 2026-02-02T22:37:26Z

P2: The parameters doc generation command doesn’t depend on the generator script or its Python module. If gen_parameters.sh or mfc/params/generators/docs_gen.py changes, parameters.md won’t be rebuilt, leaving stale documentation. Add these files to the DEPENDS list.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At CMakeLists.txt, line 690: <comment>The parameters doc generation command doesn’t depend on the generator script or its Python module. If `gen_parameters.sh` or `mfc/params/generators/docs_gen.py` changes, `parameters.md` won’t be rebuilt, leaving stale documentation. Add these files to the DEPENDS list.</comment> <file context> @@ -672,6 +672,28 @@ if (MFC_DOCUMENTATION) + file(GLOB_RECURSE params_SRCs CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/toolchain/mfc/params/*.py") + add_custom_command( + OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/docs/documentation/parameters.md" + DEPENDS "${params_SRCs}" + COMMAND "bash" "${CMAKE_CURRENT_SOURCE_DIR}/docs/gen_parameters.sh" + "${CMAKE_CURRENT_SOURCE_DIR}" </file context>

Suggested change

DEPENDS "${params_SRCs}"

DEPENDS "${params_SRCs}"

"${CMAKE_CURRENT_SOURCE_DIR}/docs/gen_parameters.sh"

"${CMAKE_CURRENT_SOURCE_DIR}/toolchain/mfc/params/generators/docs_gen.py"

-Original file line number
+Diff line change
@@ Expand Up / @@ -23,15 +23,15 @@ jobs: @@
             sudo apt install -y cmake ninja-build graphviz graphviz
             git clone https://github.com/doxygen/doxygen.git ../doxygen
             cd ../doxygen
-            git checkout 26b5403
+            git checkout Release_1_16_1
             cd -
             cmake -S ../doxygen -B ../doxygen/build -G Ninja
             sudo ninja -C ../doxygen/build install
         - name: Build Documentation
           run:  |
-            pip3 install fypp
-            cmake -S . -B build -G Ninja --install-prefix=$(pwd)/build/install -D MFC_DOCUMENTATION=ON
+            pip3 install fypp rich PyYAML
+            cmake -S . -B build -G Ninja --install-prefix="$(pwd)/build/install" -D MFC_DOCUMENTATION=ON
             ninja -C build install
         - name: Upload Built Documentation Artifact
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,7 +32,7 @@ sbatch <<EOT @@
     #SBATCH -A CFD154                  # charge account
     #SBATCH -N 1                       # Number of nodes required
     $sbatch_device_opts
-    #SBATCH -t 02:59:00                # Duration of the job (Ex: 15 mins)
+    #SBATCH -t 05:59:00                # Duration of the job (Ex: 15 mins)
     #SBATCH -o$job_slug.out            # Combined output and error messages file
     #SBATCH -p extended                # Extended partition for shorter queues
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,7 +32,7 @@ sbatch <<EOT @@
     #SBATCH -A CFD154                  # charge account
     #SBATCH -N 1                       # Number of nodes required
     $sbatch_device_opts
-    #SBATCH -t 02:59:00                # Duration of the job (Ex: 15 mins)
+    #SBATCH -t 05:59:00                # Duration of the job (Ex: 15 mins)
     #SBATCH -o$job_slug.out            # Combined output and error messages file
     #SBATCH -p extended                # Extended partition for shorter queues
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -14,9 +14,29 @@ jobs: @@
           uses: actions/setup-python@v5
           with:
             python-version: '3.14'
         - name: Initialize MFC
           run: ./mfc.sh init
-        - name: Lint the toolchain
+        - name: Lint and test the toolchain
           run: ./mfc.sh lint
+        - name: Generate toolchain files
+          run: ./mfc.sh generate
+        - name: CLI smoke tests
+          run: |
+            ./mfc.sh --help
+            ./mfc.sh build --help
+            ./mfc.sh run --help
+            ./mfc.sh test --help
+            ./mfc.sh params --count
+            ./mfc.sh new --list
+        - name: Bash completion syntax check
+          run: bash -n toolchain/completions/mfc.bash
+        - name: Validate example cases
+          run: |
+            ./mfc.sh validate examples/1D_sodshocktube/case.py
+            ./mfc.sh validate examples/2D_shockbubble/case.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,13 @@ __pycache__ @@
     # Auto-generated version file
     toolchain/mfc/_version.py
+    # Auto-generated toolchain files (regenerate with: ./mfc.sh generate)
+    toolchain/completions/mfc.bash
+    toolchain/completions/_mfc
+    toolchain/mfc-case-schema.json
+    docs/documentation/cli-reference.md
+    docs/documentation/parameters.md
     .DS_Store
     /tests/*/**
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quality of life improvements for MFC toolchain #1118

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

cubic-dev-ai bot Feb 2, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,7 @@ INOUT = "INOUT" @@
     WRONLY = "WRONLY"
     nd = "nd"
     iy = "iy"
+    iz = "iz"
     HPE = "HPE"
     alph = "alph"
     gam = "gam"
@@ Expand All / @@ -21,7 +22,12 @@ TKE = "TKE" @@
     HSA = "HSA"
     infp = "infp"
     Sur = "Sur"
-    iz = "iz"
+    chioces = "chioces"   # typo for "choices" - tests constraint key validation
+    reqires = "reqires"   # typo for "requires" - tests dependency key validation
+    choises = "choises"   # appears in comment explaining validation purpose
+    ordr = "ordr"         # typo for "order" in "weno_ordr" - tests param suggestions
+    unknwn = "unknwn"     # typo for "unknown" - tests unknown param detection
+    tru = "tru"           # typo for "true" in "when_tru" - tests dependency keys
     [files]
-    extend-exclude = ["docs/documentation/references*", "tests/", "toolchain/cce_simulation_workgroup_256.sh"]
+    extend-exclude = ["docs/documentation/references*", "tests/", "toolchain/cce_simulation_workgroup_256.sh", "build-docs/"]

-Original file line number
+Diff line change
@@ Expand Up / @@ -24,9 +24,9 @@ @@
         // Disable the extension entirely at workspace level
         "extensions.ignoreRecommendations": true,
         "extensions.autoCheckUpdates": false,
         "fortran.preferredCase": "lowercase",
         // Disable built-in linter completely but enable fortls
         "fortran.disabled": false,
         "fortran.linter.enabled": false,
@@ Expand All / @@ -45,18 +45,18 @@ @@
         "fortran.validation.diagnostics": false,
         "fortran.symbols": false,
         "fortran.hover": false,
         // Enable ONLY fortls language server
         "fortran.enableLanguageServer": true,
         "fortran.languageServer": "fortls",
         "fortran.fortls.disabled": true,
         "fortran.fortls.path": "fortls",
         // Try to disable any built-in language features
         "editor.semanticHighlighting.enabled": false,
         "editor.suggest.showWords": false,
         "editor.suggest.showSnippets": false,
         "[fortran]": {
             "editor.tabSize": 2,
             "editor.semanticHighlighting.enabled": false
@@ Expand All / @@ -69,7 +69,7 @@ @@
             "editor.tabSize": 2,
             "editor.semanticHighlighting.enabled": false
         },
         // File exclusions - multiple layers of exclusion
         "files.watcherExclude": {
             "**/misc/**": true,
@@ Expand All / @@ -80,16 +80,28 @@ @@
             "**/m_nvtx*": true,
             "**/syscheck.fpp": true
         },
         "search.exclude": {
             "**/misc/**": true,
             "**/benchmarks/**": true,
             "**/examples/**": true,
             "**/tests/**": true,
             "**/build/**": true
         },
         // Keep problems panel available
         "problems.showOn": "toggle",
-        "problems.defaultViewMode": "list"
+        "problems.defaultViewMode": "list",
+        // MFC-SCHEMA-CONFIG-BEGIN (auto-generated, do not edit)
+        "json.schemas": [
+            {
+                "fileMatch": ["**/case.json", "**/input.json", "**/mfc-case.json", "**/mfc.json"],
+                "url": "./toolchain/mfc-case-schema.json"
+            }
+        ],
+        "yaml.schemas": {
+            "./toolchain/mfc-case-schema.json": ["**/case.yaml", "**/case.yml", "**/input.yaml", "**/input.yml", "**/mfc-case.yaml", "**/mfc.yaml"]
+        }
+        // MFC-SCHEMA-CONFIG-END
     }

-Original file line number
+Diff line change
@@ Expand Up / @@ -199,6 +199,52 @@ then you can build MFC and run the test suite! @@
     ```
     And... you're done!
+    ## Toolchain Features
+    The `mfc.sh` script provides a comprehensive toolchain for building, running, and testing MFC:
+    | Command | Description |
+    |---------|-------------|
+    | `./mfc.sh build` | Build MFC and its dependencies |
+    | `./mfc.sh run case.py` | Run a simulation case |
+    | `./mfc.sh test` | Run the test suite |
+    | `./mfc.sh validate case.py` | Check a case file for errors before running |
+    | `./mfc.sh init my_case` | Create a new case from a template |
+    | `./mfc.sh clean` | Remove build artifacts |
+    | `./mfc.sh interactive` | Launch interactive menu-driven interface |
+    ### Quick Start Workflow
+    ```bash
+    ./mfc.sh init my_first_case           # Create a new case from template
+    ./mfc.sh validate my_first_case/case.py  # Validate the case file
+    ./mfc.sh build -j $(nproc)            # Build MFC
+    ./mfc.sh run my_first_case/case.py    # Run the simulation
+    ```
+    ### Case Templates
+    Create new cases quickly with built-in templates:
+    ```bash
+    ./mfc.sh init --list                  # List available templates
+    ./mfc.sh init my_case -t 2D_minimal   # Create 2D case
+    ./mfc.sh init my_case -t example:1D_sodshocktube  # Copy from examples
+    ```
+    ### Shell Completion
+    Enable tab completion for commands and options:
+    ```bash
+    # Bash
+    source toolchain/completions/mfc.bash
+    # Zsh (add to fpath)
+    fpath=(path/to/MFC/toolchain/completions $fpath)
+    autoload -Uz compinit && compinit
+    ```
     You can learn more about MFC's capabilities [via its documentation](https://mflowcode.github.io/documentation/index.html) or play with the examples located in the `examples/` directory (some are [shown here](https://mflowcode.github.io/documentation/md_examples.html))!
     The shock-droplet interaction case above was run via
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,9 @@ @@
     # - weno_order : 3
     # - riemann_solver : 2
-    import json, math, argparse
+    import json
+    import math
+    import argparse
     parser = argparse.ArgumentParser(prog="Benchmarking Case 1", description="This MFC case was created for the purposes of benchmarking MFC.", formatter_class=argparse.ArgumentDefaultsHelpFormatter)
@@ Expand Down Expand Up / @@ -40,7 +42,7 @@ @@
     # the droplet is about D0/8
     ISD = 5.0 / 8 * D0
-    ## pre-shock properties - AIR
+    # pre-shock properties - AIR
     # pressure - Pa
     p0a = patm
@@ Expand All / @@ -57,7 +59,7 @@ @@
     # speed of sound - M/s
     c_a = math.sqrt(gama * (p0a + pia) / rho0a)
-    ## Droplet - WATER
+    # Droplet - WATER
     # surface tension - N / m
     st = 0.00e0
@@ Expand All / @@ -84,7 +86,7 @@ @@
     # Min or psOp0a. Just comment/uncomment appropriately
     Min = 2.4
-    ## Pos to pre shock ratios - AIR
+    # Pos to pre shock ratios - AIR
     # pressure
     psOp0a = (Min**2 - 1) * 2 * gama / (gama + 1) + 1
@@ Expand All / @@ -99,7 +101,7 @@ @@
     # shock speed of sound - m/s
     ss = Ms * c_a
-    ## post-shock - AIR
+    # post-shock - AIR
     # pressure - Pa
     ps = psOp0a * p0a
@@ Expand All / @@ -113,7 +115,7 @@ @@
     # velocity at the post shock - m/s
     vel = c_a / gama * (psOp0a - 1.0) * p0a / (p0a + pia) / Ms
-    ## Domain boundaries - m
+    # Domain boundaries - m
     # x direction
     xb = -8.4707 * D0
@@ Expand Down Expand Up / @@ -156,7 +158,7 @@ @@
     # Save Frequency. Note that the number of autosaves will be SF + 1, as th IC (0.dat) is also saved
     SF = 400
-    ## making Nt divisible by SF
+    # making Nt divisible by SF
     # 1 - ensure NtA goes slightly beyond tendA
     NtA = int(tendA // dt + 1)
@@ Expand Down @@

Quality of life improvements for MFC toolchain #1118

Uh oh!

Quality of life improvements for MFC toolchain #1118

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

cubic-dev-ai bot Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai bot Feb 2, 2026 •

edited

Loading