diff options
| author | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 15:37:25 -0400 |
|---|---|---|
| committer | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 15:37:25 -0400 |
| commit | 3fe64420f18718e585cb36f4331edbf74a3d480e (patch) | |
| tree | 13829a18ac05db22943a28c5e1e0e6d4cd2e320e | |
| parent | abb88085d5d315237c504c709d6786f78a7a1740 (diff) | |
| download | c++-3fe64420f18718e585cb36f4331edbf74a3d480e.tar.gz c++-3fe64420f18718e585cb36f4331edbf74a3d480e.tar.bz2 c++-3fe64420f18718e585cb36f4331edbf74a3d480e.zip | |
added introduction to the documentation
| -rw-r--r-- | README | 6 | ||||
| -rw-r--r-- | doc/index.rst | 1 | ||||
| -rw-r--r-- | doc/introduction.rst | 39 |
3 files changed, 43 insertions, 3 deletions
@@ -1,10 +1,10 @@ A library for running the Wolff algorithm on arbitrary systems in arbitrary fields. A "spin state" and "spin symmetry transformation" type must be -supplied to defined a system, along with a spin-spin coupling, a spin-field +supplied to define a system, along with a spin-spin coupling, a spin-field coupling, and a generator of transformations of rank two. The library then -supplies the tools to run Wolff cluster-flip steps on the resulting (for now) -hypercubic lattice system, with arbitrary measurements taken along the way. +supplies the tools to run Wolff cluster-flip Monte Carlo on the resulting +system, with arbitrary measurements taken along the way. See INSTALL for installation details. diff --git a/doc/index.rst b/doc/index.rst index 98f1e76..7b156d3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,6 +5,7 @@ Wolff Library .. toctree :: :maxdepth: 2 + introduction examples models system diff --git a/doc/introduction.rst b/doc/introduction.rst new file mode 100644 index 0000000..9f0b190 --- /dev/null +++ b/doc/introduction.rst @@ -0,0 +1,39 @@ + +************ +Introduction +************ + +A library for running the Wolff algorithm on arbitrary systems in arbitrary +fields. A "spin state" and "spin symmetry transformation" type must be supplied +to define a system, along with a spin-spin coupling, a spin-field coupling, +and a generator of transformations of rank two. The library then supplies the +tools to run Wolff cluster-flip Monte Carlo on the resulting system, with +arbitrary measurements taken along the way. + +A detailed description of the algorithm and its requirements can be found at https://arxiv.org/abs/1805.04019. + +Getting Wolff +============= + +This source for this library is available at https://git.kent-dobias.com/wolff/. + +Installation +============ + +The only dependencies are a modern C++ compiler, cmake, and the standard libraries. With those at hand, the Wolff library and the provided examples can be built and installed using + +.. code-block:: bash + + git clone https://git.kent-dobias.com/wolff/ + mkdir wolff/build + cd wolff/build + cmake .. + make install + +Custom install paths and compiler optimizations can be passed to cmake in the standard ways. + +License +======= + +Wolff is licensed under the MIT license, a copy of which is included with the source code. The terms can be found here: https://spdx.org/licenses/MIT.html. + |