Skip to content

Commit a6d2641

Browse files
committed
Address PR MFlowCode#1038 feedback: standardize Homebrew command syntax
- Use shorthand 'mfc case.py' consistently across all documentation - Clarify that both 'mfc case.py' and 'mfc run case.py' work - Update README.md, packaging/homebrew/README.md, getting-started.md, and running.md - Improves consistency and showcases the smart detection feature Addresses Copilot AI review comment about documentation inconsistency
1 parent 3e4ba96 commit a6d2641

File tree

4 files changed

+13
-8
lines changed

4 files changed

+13
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ Install the prebuilt package and run an example:
146146
brew install mflowcode/mfc/mfc
147147
mkdir -p ~/mfc_quickstart && cd ~/mfc_quickstart
148148
cp $(brew --prefix mfc)/examples/1D_sodshocktube/case.py .
149-
mfc run case.py -n 2
149+
mfc case.py -n 2
150150
```
151151

152-
Use `-n X` to select the number of MPI processes. For developer commands (`build`, `test`, etc.), clone the repo and use `./mfc.sh`.
152+
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`.
153153

154154
### macOS from source
155155

docs/documentation/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ Run a quick example:
2323
mkdir -p ~/mfc_quickstart && cd ~/mfc_quickstart
2424
cp $(brew --prefix mfc)/examples/1D_sodshocktube/case.py .
2525
# Use -n X to choose the number of MPI processes
26-
mfc run case.py -n 2
26+
mfc case.py -n 2
2727
```
2828

2929
Notes:
30-
- The Homebrew wrapper supports only `mfc run ...`. Developer commands like `build`, `test`, `clean` are available when you clone the repo and use `./mfc.sh`.
30+
- Both `mfc case.py` and `mfc run case.py` work (shorthand auto-detects case files).
31+
- Developer commands like `build`, `test`, `clean` are available when you clone the repo and use `./mfc.sh`.
3132
- The package bundles a Python venv and prebuilt binaries; no additional setup is required.
3233
- Examples are installed at `$(brew --prefix mfc)/examples/`.
3334

docs/documentation/running.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ several supercomputer clusters, both interactively and through batch submission.
1313
If you installed MFC via Homebrew, run cases with the `mfc` wrapper:
1414

1515
```bash
16+
mfc <path/to/case.py> -n 2
17+
# or explicitly:
1618
mfc run <path/to/case.py> -n 2
1719
```
1820

1921
- Use `-n X` to control the number of MPI processes (ranks).
20-
- Only the `run` command is supported in the Homebrew wrapper.
22+
- Both `mfc case.py` and `mfc run case.py` work (shorthand auto-detects case files).
2123
- To use developer commands (`build`, `test`, `clean`, etc.), clone the repository and use `./mfc.sh`.
2224
- The wrapper passes through runtime flags like `-t pre_process simulation`, `-n`, and others; it always runs with preinstalled binaries.
2325
- Examples live at `$(brew --prefix mfc)/examples/`.

packaging/homebrew/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Run the 1D Sod shock tube example:
1515
```bash
1616
mkdir -p ~/mfc_example && cd ~/mfc_example
1717
cp $(brew --prefix mfc)/examples/1D_sodshocktube/case.py .
18-
mfc run case.py -n 2
18+
mfc case.py -n 2
1919
```
2020

2121
## What's Included
@@ -28,12 +28,14 @@ mfc run case.py -n 2
2828
## Usage
2929

3030
```bash
31+
mfc <case.py> -n <processes>
32+
# or explicitly:
3133
mfc run <case.py> -n <processes>
3234
```
3335

34-
Use `-n X` to set the number of MPI processes.
36+
Use `-n X` to set the number of MPI processes. Both syntaxes work (the shorthand version auto-detects case files).
3537

36-
**Note**: The Homebrew wrapper supports only `mfc run`. For developer commands (`build`, `test`, `clean`, etc.), [clone the repository](https://github.com/MFlowCode/MFC) and use `./mfc.sh`.
38+
**Note**: The Homebrew wrapper supports only running cases. For developer commands (`build`, `test`, `clean`, etc.), [clone the repository](https://github.com/MFlowCode/MFC) and use `./mfc.sh`.
3739

3840
## Documentation
3941

0 commit comments

Comments
 (0)