From aed8d4f0448bae1e68cf4ff2af0fce87768b921c Mon Sep 17 00:00:00 2001 From: Jaron Kent-Dobias Date: Fri, 19 Oct 2018 14:49:08 -0400 Subject: updated install and readme files --- INSTALL | 18 +++++++++++++++--- README | 13 ++++--------- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/INSTALL b/INSTALL index ff00242..70d233b 100644 --- a/INSTALL +++ b/INSTALL @@ -1,12 +1,24 @@ -To install, initialize cmake in a build directory, e.g., +To build all examples and install the library, initialize cmake in a build +directory, e.g., # mkdir build # cd build # cmake .. # make +# make install The core library requires only the standard C++ libraries and a modern -compiler. Most of the example code also has no dependencies. Compilation of -examples/tools/analyze_correlations.cpp requires the FFTW3 library. +compiler. Most of the example code also has no dependencies, with the exception +of ising_animation, which requires the glut library. + +The documentation can be built into a variety of formats using Sphinx. To list available options, + +# cd doc +# mkdir _build +# make + +Building the documentation on the website is accomplished by then running + +# make html diff --git a/README b/README index 2321cc7..3773cf9 100644 --- a/README +++ b/README @@ -6,14 +6,9 @@ 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. -The core code resides in lib. lib/include/wolff.hpp is the principle -interface, but lib/include/wolff/cluster.hpp does the heavy lifting, with -essential data structures defined by lib/include/wolff/graph.h and -lib/include/wolff/state.h. Skimming these files, or reviewing how they are -used in the included examples, should help with their use. The simplest -example is contained in examples/src/models/ising. +See INSTALL for installation details. -lib/include/wolff/finite_states.h can be invoked when special objects have -been defined to significantly speed computation for systems whose spins have -finitely many states. +Documentation is present in doc/ and can be built using Sphinx into a variety +of formats. The current version of this documentation can also be found at +https://doc.kent-dobias.com/wolff. -- cgit v1.2.3-70-g09d2