diff --git a/README.md b/README.md index 27ce713..ccde625 100644 --- a/README.md +++ b/README.md @@ -3,29 +3,29 @@ Modelling with the total **el**ectric field approach using **f**inite **e**lemen _About:_ -**elfe3D** is a 3D forward modelling code that can simulate electric and magnetic field responses from frequency-domain controlled-source electromagnetic setups. It uses tetrahedral meshes and first-order finite-element approximations. In addition, adaptive mesh refinement approaches are implemented. +`elfe3D` is a 3D forward modelling code that can simulate electric and magnetic field responses from frequency-domain controlled-source electromagnetic setups. It uses tetrahedral meshes and first-order finite-element approximations. In addition, adaptive mesh refinement approaches are implemented. _Contributions:_ -A first version of **elfe3D** was developed by Paula Rulff with contributions from Laura Maria Buntin and Thomas Kalscheuer at Uppsala University from 2018-2023. +A first version of `elfe3D` was developed by Paula Rulff with contributions from Laura Maria Buntin and Thomas Kalscheuer at Uppsala University from 2018-2023. -Further developments of **elfe3D** by Paula Rulff, now at Delft University of Technology, are ongoing. Suggestions for improvements are welcome! +Further developments of `elfe3D` by Paula Rulff, now at Delft University of Technology, are ongoing. Suggestions for improvements are welcome! _Contact_: p.rulff@tudelft.nl _Getting started:_ -You find the **elfe3D** manual including instalation instructions in `elfe3D/elfe3D/README.md` +You find the `elfe3D` manual including instalation instructions in `elfe3D/elfe3D/README.md` Note that, the open source mesh generator `tetgen` and the direct solver `MUMPS` must be installed additionally. _Credits:_ -If you publish results generated with **elfe3D**, please give credit to the **elfe3D** developers by citing: +If you publish results generated with `elfe3D`, please give credit to the `elfe3D` developers by citing: Paula Rulff, Laura M Buntin, Thomas Kalscheuer, Efficient goal-oriented mesh refinement in 3-D finite-element modelling adapted for controlled source electromagnetic surveys, Geophysical Journal International, Volume 227, Issue 3, December 2021, Pages 1624–1645, https://doi.org/10.1093/gji/ggab264 -and refer to the **elfe3D** the version you used via the ZENODO DOI. +and refer to the `elfe3D` the version you used via the ZENODO DOI. Do not forget to acknowledge `MUMPS` and `tetgen` developers!