summaryrefslogtreecommitdiff
path: root/doc/examples.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/examples.rst')
-rw-r--r--doc/examples.rst10
1 files changed, 10 insertions, 0 deletions
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
+