Skip to content

Commit 2057798

Browse files
sbryngelsonclaude
andcommitted
Clean up README: fix init->new, remove duplicate run instructions
Fix outdated 'init' subcommand references to 'new' in the Toolchain table and tab completion note. Remove duplicate shock-droplet run command and visualization text already covered in Try MFC section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bd75c5f commit 2057798

1 file changed

Lines changed: 2 additions & 9 deletions

File tree

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,18 +102,11 @@ And a high-amplitude acoustic wave reflecting and emerging through a circular or
102102
| `./mfc.sh run case.py` | Run a simulation case (interactive or batch: SLURM/PBS/LSF) |
103103
| `./mfc.sh test` | Run the test suite |
104104
| `./mfc.sh validate case.py` | Check a case file for errors before running |
105-
| `./mfc.sh init my_case` | Create a new case from a template |
105+
| `./mfc.sh new my_case` | Create a new case from a template |
106106
| `./mfc.sh clean` | Remove build artifacts |
107107
| `./mfc.sh interactive` | Launch interactive menu-driven interface |
108108

109-
Run `./mfc.sh <command> --help` for detailed options, or see the [full documentation](https://mflowcode.github.io/documentation/index.html). Tab completion for bash and zsh is auto-installed after you have run `./mfc.sh generate` (or any non-`init` command) at least once. Play with the examples in `examples/` ([showcased here](https://mflowcode.github.io/documentation/examples.html)).
110-
111-
The shock-droplet interaction case above was run via
112-
```shell
113-
./mfc.sh run -n $(nproc) ./examples/3D_shockdroplet/case.py
114-
```
115-
where `$(nproc)` is the number of cores the example will run on (and the number of physical cores on your CPU device).
116-
You can visualize the output data in `examples/3D_shockdroplet/silo_hdf5` via Paraview, Visit, or your favorite software.
109+
Run `./mfc.sh <command> --help` for detailed options, or see the [full documentation](https://mflowcode.github.io/documentation/index.html). Tab completion for bash and zsh is auto-installed after you have run `./mfc.sh generate` (or any non-`new` command) at least once. Play with the examples in `examples/` ([showcased here](https://mflowcode.github.io/documentation/examples.html)).
117110

118111
## Is this _really_ exascale?
119112

0 commit comments

Comments
 (0)