You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
@@ -127,26 +132,43 @@ And here is a high-amplitude acoustic wave reflecting and emerging through a cir
127
132
128
133
## Getting started
129
134
135
+
You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer!
For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands.
131
146
Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd> (right tab) → <kbd>+</kbd> (create a codespace).
132
147
148
+
Alternatively, run MFC directly with Docker on your local machine:
149
+
```bash
150
+
docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu
151
+
```
152
+
Once inside the container, navigate to `/opt/MFC` to access MFC and run examples.
153
+
133
154
> ****Note:**** Codespaces is a free service with a monthly quota of compute time and storage usage.
134
155
> It is recommended for testing commands, troubleshooting, and running simple case files without installing dependencies or building MFC on your device.
135
156
> Don't conduct any critical work here!
136
157
> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/md_docker.html).
137
158
138
-
You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer!
- 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
+
- The Homebrew package uses a simplified syntax: just `mfc <case.py>` to run cases.
31
+
- Developer commands like `build`, `test`, `clean` are available when you clone the repo and use `./mfc.sh`.
31
32
- The package bundles a Python venv and prebuilt binaries; no additional setup is required.
32
33
- Examples are installed at `$(brew --prefix mfc)/examples/`.
0 commit comments