Skip to content

readme #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2025
+7 −0
Merged

readme #1049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ MFC runs at exascale on the world's fastest supercomputers:
| Path | Command |
| --- | --- |
| **Codespaces** (fastest) 💨 | Click the "Codespaces" badge above to launch in 1 click |
| **Docker** 🐳 | `docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu` |
| **Homebrew** (macOS) 🍺 | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Local build** 💻 | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |

Expand Down Expand Up @@ -140,6 +141,12 @@ Some examples are below.
For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands.
Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd> (right tab) → <kbd>+</kbd> (create a codespace).

Alternatively, run MFC directly with Docker on your local machine:
```bash
docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu
```
Once inside the container, navigate to `/opt/MFC` to access MFC and run examples.
Comment on lines +144 to +148
Copy link
Contributor

@qodo-merge-pro qodo-merge-pro bot Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Modify the docker run command to mount the current host directory as a volume inside the container. This will persist any generated files on the user's machine after the container exits. [general, importance: 7]

Suggested change
Alternatively, run MFC directly with Docker on your local machine:
```bash
docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu
```
Once inside the container, navigate to `/opt/MFC` to access MFC and run examples.
Alternatively, run MFC directly with Docker on your local machine. This command mounts your current directory into the container at `/work` so that any generated files are saved on your machine:
```bash
docker run -it --rm -v "$(pwd)":/work -w /work --entrypoint bash sbryngelson/mfc:latest-cpu

Once inside the container, you can copy examples from /opt/MFC/examples to your current directory (/work), run them, and the output will appear on your host machine.


> ****Note:**** Codespaces is a free service with a monthly quota of compute time and storage usage.
> It is recommended for testing commands, troubleshooting, and running simple case files without installing dependencies or building MFC on your device.
> Don't conduct any critical work here!
Expand Down