BOUT-dev icon indicating copy to clipboard operation
BOUT-dev copied to clipboard

Link to BOUT++ papers in the manual?

Open johnomotani opened this issue 3 years ago • 3 comments

Apologies if I've missed it by skimming too quickly, but should we have a section linking to the main BOUT++ papers in the manual where users will find it easily? I could only find the citations either in CITATION.cff/CITATION.bib, or in the big list of papers http://boutproject.github.io/publications/. The papers can be useful for a more structured overview of BOUT++ than the manual gives (came up in a discussion with Theo Gheorghiu).

Maybe we could add to the 'Introduction' a subsection with something like:

BOUT++ review papers
--------------------

Several review papers on BOUT++ have been written. These are necessarily a little out of date, but still useful for an overview of the aims of the code and the design decisions that have been taken.

* B.D. Dudson, M.V. Umansky, X.Q. Xu, P.B. Snyder, H.R. Wilson, "BOUT++: a framework for parallel plasma fluid simulations" *Computer Physics Communications* **180**, 1467-1480 (2009) `doi:10.1016/j.cpc.2009.03.008 <https://doi.org/10.1016/j.cpc.2009.03.008>`_. `arXiv pre-print <http://arxiv.org/abs/0810.5757>`_.
| The original paper presenting BOUT++

* B.D. Dudson, A. Allen, G. Breyiannis, E. Brugger, J. Buchanan, L. Easy, S. Farley, I. Joseph, M. Kim, A.D. McGann, J.T. Omotani, M.V. Umansky, N.R. Walkden, T. Xia, X.Q. Xu, "BOUT++: Recent and current developments", *Journal of Plasma Physics" **81**(1), 365810104 (2014) `doi:10.1017/S0022377814000816 <https://doi.org/10.1017/S0022377814000816>`_. `arXiv pre-print <http://arxiv.org/abs/1405.7905>`_.
| 2014 update: more description of code structure; physics-based preconditioning; grid generation.

* B.D. Dudson, J. Madsen, J. Omotani, P. Hill, L. Easy, M. Loiten, "Verification of BOUT++ by the Method of Manufactured Solutions", *Physics of Plasmas* **23**, 062303 (2016) `doi:10.1063/1.4953429 <https://doi.org/10.1063/1.4953429>`_. `arXiv pre-print <http://arxiv.org/abs/1602.06747>`_.
| 2016 update: mostly about verification using the 'Method of Manufactured Solutions' (MMS); briefly introduces the 'Flux Coordinate Independent' (FCI) scheme.

johnomotani avatar Sep 21 '21 16:09 johnomotani

Yes I think this would be good, thanks!

Perhaps it would also be useful to have a link to some papers on particular models (e.g. STORM), or links to online manuals or repositories?

bendudson avatar Sep 21 '21 16:09 bendudson

Perhaps it would also be useful to have a link to some papers on particular models (e.g. STORM), or links to online manuals or repositories?

I'd vote for links to repos/manuals - otherwise this section of the manual is liable to get out of date, like the publications list on boutproject.github.io!

johnomotani avatar Sep 21 '21 17:09 johnomotani

Fair point. Having only one place to keep up to date (or not!) would be better than adding another. Links to repos and manuals for codes which use BOUT++ would be nice.

bendudson avatar Sep 21 '21 17:09 bendudson