Homebrew formula

[sbryngelson]

PR Type

Documentation

---

Description

• Update Homebrew wrapper documentation to reflect shorthand syntax support

• Document that both mfc case.py and mfc run case.py commands work

• Clarify that shorthand version auto-detects case files

• Simplify notes about Homebrew wrapper capabilities

---

Diagram Walkthrough

flowchart LR
  A["Documentation Files"] -->|"Update command examples"| B["README.md"]
  A -->|"Update getting-started guide"| C["docs/documentation/getting-started.md"]
  A -->|"Update running guide"| D["docs/documentation/running.md"]
  A -->|"Update packaging docs"| E["packaging/homebrew/README.md"]
  B -->|"Reflect"| F["Shorthand syntax support"]
  C -->|"Reflect"| F
  D -->|"Reflect"| F
  E -->|"Reflect"| F

Loading

File Walkthrough

Relevant files

Documentation

README.md Update primary command example to shorthand syntax              README.md Changed primary example from mfc run case.py to mfc case.py Added note that both command syntaxes work Updated documentation to reflect shorthand auto-detection capability +2/-2      getting-started.md Update getting-started guide with shorthand syntax              docs/documentation/getting-started.md Updated example command from mfc run case.py to mfc case.py Added bullet point clarifying both syntaxes work with auto-detection Separated developer commands note for clarity +3/-2      running.md Add shorthand syntax documentation to running guide            docs/documentation/running.md Added shorthand syntax example mfc Included explicit mfc run syntax as alternative Updated note to clarify both syntaxes are supported +3/-1      README.md Update Homebrew packaging documentation with shorthand syntax packaging/homebrew/README.md Updated example from mfc run case.py to mfc case.py Added shorthand syntax with explicit alternative Clarified that both syntaxes work with auto-detection Updated note to reflect wrapper supports case running only +5/-3

---

Note

Updates Homebrew-related docs to show mfc <case.py> shorthand works alongside mfc run <case.py> and clarifies wrapper vs. developer commands.

• Documentation (Homebrew usage):
  • README updates in README.md, docs/documentation/getting-started.md, docs/documentation/running.md, packaging/homebrew/README.md.
  • Note that both mfc <case.py> and mfc run <case.py> are supported (shorthand auto-detects case files).
  • Clarify that developer commands (build, test, clean, etc.) require cloning the repo and using ./mfc.sh.
  • Adjust quick-start examples to use mfc <case.py> -n 2; retain explicit mfc run ... as an alternative.

^{Written by Cursor Bugbot for commit a6d2641. Configure here.}

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Consistency Multiple docs now claim both mfc case.py and mfc run case.py work. Verify the Homebrew wrapper actually supports the shorthand invocation in all environments (path detection, file auto-detect) to avoid user confusion. brew install mflowcode/mfc/mfc mkdir -p ~/mfc_quickstart && cd ~/mfc_quickstart cp $(brew --prefix mfc)/examples/1D_sodshocktube/case.py . mfc case.py -n 2 Use -n X to select the number of MPI processes. Both mfc case.py and mfc run case.py work. For developer commands (build, test, etc.), clone the repo and use ./mfc.sh. </details> <details><summary><a href='https://github.com/MFlowCode/MFC/pull/1039/files#diff-ac1cb40c48f1535400ea846a15de7f139377474136ba2a611ac03e0d55da8e19R13-R23'><strong>Duplication</strong></a> Guidance about shorthand versus explicit `run` is repeated across README, getting-started, running, and packaging docs; consider extracting a single canonical note to avoid drift. </summary> ```markdown If you installed MFC via Homebrew, run cases with the `mfc` wrapper: ```bash mfc <path/to/case.py> -n 2 # or explicitly: mfc run <path/to/case.py> -n 2 Use -n X to control the number of MPI processes (ranks). Both mfc case.py and mfc run case.py work (shorthand auto-detects case files). To use developer commands (build, test, clean, etc.), clone the repository and use ./mfc.sh. </details> </td></tr> </table>

[Copilot]

Pull Request Overview

This PR updates documentation across multiple files to introduce a shorthand syntax for the Homebrew MFC wrapper, allowing users to run mfc case.py directly instead of requiring mfc run case.py.

Key changes:

• Updated command examples from mfc run case.py to mfc case.py (shorthand syntax)
• Added explanatory notes that both syntaxes work, with shorthand auto-detecting case files
• Clarified that only running cases is supported in the Homebrew wrapper (refined from "only mfc run")

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
packaging/homebrew/README.md	Updated quick start and usage examples to showcase shorthand syntax; clarified wrapper limitations
docs/documentation/running.md	Updated Homebrew usage section to document both command syntaxes
docs/documentation/getting-started.md	Updated Homebrew quick start example and notes to reflect shorthand syntax
README.md	Updated macOS quick start section with shorthand syntax example

[sbryngelson]

/improve

[qodo-merge-pro]

✅ Suggestion: Add validation to ensure the first non-flag argument is a Python case file before prepending the run command, providing clearer error messages for invalid input. [general, importance: 7]

New proposed code:

 # Always prepend "run" since this wrapper only supports running cases
+# Validate that the first non-flag arg looks like a case file for clearer errors
+first_nonflag=""
+for a in "${ARGS[@]}"; do
+  if [[ "$a" != -* ]]; then
+    first_nonflag="$a"
+    break
+  fi
+done
+
+if [[ -z "${first_nonflag}" ]]; then
+  echo "mfc (Homebrew): missing case file. Usage: mfc <case.py> [options]"
+  exit 2
+fi
+
+if [[ ! "${first_nonflag}" =~ \.py$ ]] && [[ ! -f "${first_nonflag}" ]]; then
+  echo "mfc (Homebrew): first non-flag argument must be a Python case file."
+  echo "Given: ${first_nonflag}"
+  exit 2
+fi
+
 ARGS=("run" "${ARGS[@]}")
 
 # Create a temporary working directory (Cellar is read-only)
 TMPDIR="$(mktemp -d)"
 trap 'rm -rf "${TMPDIR}"' EXIT

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

[sbryngelson]

/improve

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.