Skip to content

Commit 377d120

Browse files
committed
updated user guide. updated readme to include new citations.
1 parent c667482 commit 377d120

File tree

2 files changed

+1408
-6
lines changed

2 files changed

+1408
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,25 @@ for multi-component, multi-phase, and bubbly flows.
3333
## MFC paper
3434

3535
The paper that describes the MFC's capabilities:
36-
* <a href="https://arxiv.org/pdf/1907.10512.pdf">
37-
S. H. Bryngelson, K. Schmidmayer, V. Coralic, K. Maeda, J. Meng, T. Colonius (2019) arXiv: 1907.10512
36+
* <a href="http://dx.doi.org/https://doi.org/10.1016/j.cpc.2020.107396">
37+
S. H. Bryngelson, K. Schmidmayer, V. Coralic, K. Maeda, J. Meng, T. Colonius (2020) Computer Physics Communications 4655, 107396
3838
</a>
39-
39+
40+
### Cite me!
41+
42+
```
43+
@article{Bryngelson_2020,
44+
title = {MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver},
45+
author = {Spencer H. Bryngelson and Kevin Schmidmayer and Vedran Coralic and Jomela C. Meng and Kazuki Maeda and Tim Colonius},
46+
journal = {Computer Physics Communications},
47+
doi = {10.1016/j.cpc.2020.107396},
48+
year = 2020,
49+
month = {may},
50+
publisher = {Elsevier {BV}},
51+
pages = {107396},
52+
}
53+
```
54+
4055
## Related publications
4156

4257
Several publications have used the MFC in various stages of its
@@ -98,14 +113,14 @@ Ph.D. Disserations:
98113

99114
### Main dependencies: MPI and Python
100115
If you do not have Python, it can be installed via
101-
<a href="https://brew.sh/">Homebrew on OSX</a> as:
116+
<a href="https://brew.sh/">Homebrew on MacOS</a> as:
102117
`brew install python`
103118

104119
or compiled via your favorite package manager on Unix systems.
105120

106121
An MPI fortran compiler is required for all systems.
107122
If you do not have one, Homebrew can take care of this
108-
on OSX:
123+
on MacOS:
109124
`brew install open-mpi`
110125

111126
or compiled via another package manager on Unix systems.
@@ -129,7 +144,7 @@ If you do not have FFTW compiler, the library and
129144
but can indeed be handled with the MFC. For this, HDF5
130145
and Silo must be installed
131146

132-
On OSX, a custom Homebrew tap for Silo is included in the installers
147+
On MacOS, a custom Homebrew tap for Silo is included in the installers
133148
directory. You can use it via
134149
`cd installers`
135150
`brew install silo.rb`

0 commit comments

Comments
 (0)