Skip to content

Commit 7386504

Browse files
authored
readme (#1049)
1 parent 9333c68 commit 7386504

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ MFC runs at exascale on the world's fastest supercomputers:
6060
| Path | Command |
6161
| --- | --- |
6262
| **Codespaces** (fastest) 💨 | Click the "Codespaces" badge above to launch in 1 click |
63+
| **Docker** 🐳 | `docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu` |
6364
| **Homebrew** (macOS) 🍺 | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
6465
| **Local build** 💻 | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |
6566

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

144+
Alternatively, run MFC directly with Docker on your local machine:
145+
```bash
146+
docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu
147+
```
148+
Once inside the container, navigate to `/opt/MFC` to access MFC and run examples.
149+
143150
> ****Note:**** Codespaces is a free service with a monthly quota of compute time and storage usage.
144151
> It is recommended for testing commands, troubleshooting, and running simple case files without installing dependencies or building MFC on your device.
145152
> Don't conduct any critical work here!

0 commit comments

Comments
 (0)