diff options
| author | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 13:23:23 -0400 |
|---|---|---|
| committer | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 13:23:23 -0400 |
| commit | 3b8e7ea25f0c23ca596c1c4e3e4f71d12c5fc065 (patch) | |
| tree | 0400d589c68aaf38381591072e8faad09d3779f8 /doc | |
| parent | 864e288c5cb51ae94ac09db8597714c605344c3d (diff) | |
| download | c++-3b8e7ea25f0c23ca596c1c4e3e4f71d12c5fc065.tar.gz c++-3b8e7ea25f0c23ca596c1c4e3e4f71d12c5fc065.tar.bz2 c++-3b8e7ea25f0c23ca596c1c4e3e4f71d12c5fc065.zip | |
added more examples and cleaned up the model headers
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 |