Introduction¶
About¶
Faunus is a general Monte Carlo simulation code, designed to be flexible, easy to use, and to modify. The code is written in C++ and Python bindings are available. The development is a team effort with, in reverse chronological order, many valiant contributions from:
Marco Polimeni, Vidar Aspelin, Stefan Hervø-Hansen, Richard Chudoba, Niels Kouwenhoven, Coralie Pasquier, Lukáš Sukeník, Giulio Tesei, Alexei Abrikossov, João Henriques, Björn Stenqvist, Axel Thuresson, Robert Vácha, Magnus Ullner, Chris Evers, Anıl Kurut, Fernando Luís Barroso da Silva, André Teixeira, Christophe Labbez, Ondrej Marsalek, Martin Trulsson, Björn Persson, Mikael Lund
Should you find Faunus useful, please consider supporting us by crediting:
- Stenqvist et al. Molecular Simulation 2013, 39:1233 [citing articles].
- Lund, M. et al. Source Code Biol. Med., 2008, 3:1 [citing articles].
Quick Start¶
Simulations are set up using YAML or JSON files, see for example minimal.yml, for a Metropolis Monte Carlo simulation of charged Lennard-Jones particles. Running with
yason.py minimal.yml | faunus
produces an output file, out.json
, with move statistics, system properties etc.
The script yason.py
merely converts from YAML to JSON as the former, easier to read,
is used in all examples.
For more examples, see the examples
folder.
Getting Help¶
To open the user-guide in a browser, type:
faunus-manual
If you have questions, comments, or need help, create a ticket on our Github issue page.