summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJaron Kent-Dobias <jaron@kent-dobias.com>2018-10-19 15:37:25 -0400
committerJaron Kent-Dobias <jaron@kent-dobias.com>2018-10-19 15:37:25 -0400
commit3fe64420f18718e585cb36f4331edbf74a3d480e (patch)
tree13829a18ac05db22943a28c5e1e0e6d4cd2e320e /README
parentabb88085d5d315237c504c709d6786f78a7a1740 (diff)
downloadc++-3fe64420f18718e585cb36f4331edbf74a3d480e.tar.gz
c++-3fe64420f18718e585cb36f4331edbf74a3d480e.tar.bz2
c++-3fe64420f18718e585cb36f4331edbf74a3d480e.zip
added introduction to the documentation
Diffstat (limited to 'README')
-rw-r--r--README6
1 files changed, 3 insertions, 3 deletions
diff --git a/README b/README
index 3773cf9..43bae10 100644
--- a/README
+++ b/README
@@ -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.