From 3b8e7ea25f0c23ca596c1c4e3e4f71d12c5fc065 Mon Sep 17 00:00:00 2001 From: Jaron Kent-Dobias Date: Fri, 19 Oct 2018 13:23:23 -0400 Subject: added more examples and cleaned up the model headers --- doc/examples.rst | 10 ++++++++++ doc/index.rst | 5 +++-- 2 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 doc/examples.rst (limited to 'doc') diff --git a/doc/examples.rst b/doc/examples.rst new file mode 100644 index 0000000..71b70ce --- /dev/null +++ b/doc/examples.rst @@ -0,0 +1,10 @@ + +******** +Examples +******** + +Several examples are included in the directory :file:`examples/`. The simplist, standalone example of measuring the average cluster size of an Ising model is provided in full below, demonstrating how to define a model, measurement, couplings, and initialize the algorithm. + +.. literalinclude:: ../examples/ising_standalone.cpp + :language: cpp + diff --git a/doc/index.rst b/doc/index.rst index 4e58e46..98f1e76 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,10 +1,11 @@ -Wolff Libraries -+++++++++++++++ +Wolff Library ++++++++++++++ .. toctree :: :maxdepth: 2 + examples models system measurement -- cgit v1.2.3-70-g09d2