diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/examples.rst | 10 | ||||
| -rw-r--r-- | doc/index.rst | 5 |
2 files changed, 13 insertions, 2 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 + 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 |