ALPS MPS Codes
Reference documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
doc/alps_mps.md
Go to the documentation of this file.
1 # Documentation {#mainpage}
2 
3 ## Using the code
4 Example simulations are available in the `tutorials/mps-XX-YY` folders. In order to run them you need a complete installation of ALPS, i.e. including the Python tools. The python scripts must be executed with the `alpspython` program, such that the ALPS libraries are imported correclty.
5 
6 For the first tutorial:
7 
8  $ cd tutorials/mps-01-optim
9  $ alpspython spin_one_half.py
10 
11 ### Parameters
12 In the [Parameters section](@ref parameters) one can find a detailed description of the simulation parameters for all the ALPS %MPS tools.
13 
14 
15 ## File list
16 A short description of the source files is available in the [File list section](files.html).
17 
18 ## Installation
19 
20 
21 ### Dependencies
22 
23  * CMake >= 2.8.x
24  * Boost C++ libraries >= 1.52.0
25  * HDF5 >= 1.8.2
26  * BLAS and LAPACK libraries
27  * Python 2.6.x or 2.7.x with Numpy, SciPy, Matplotlib.
28 
29 Example package names for the above dependencies are available on the [ALPS website][alps-web].
30 
31 
32 ### Build
33 
34 The CMake configuration system will find automatically most
35 dependencies. In case of configuration problems, please refer to the
36 [ALPS website][alps-web] and the [ALPS-Users forum][alps-mail].
37 
38 For a Unix or Darwin system, the following command are enough to build
39 the package. For Windows it is advised to use the CMake GUI utility or
40 to download a binary installer (>=2.2.0b1) from the [ALPS website][alps-web].
41 
42 #### Configuration
43 
44  $ cd build
45  $ cmake ../alps
46 
47 #### Compile and install
48 
49  $ make # -jN for compilation in parallel using N processes
50  $ make install
51 
52 
53 ## License
54 See alps/LICENSE.txt and alps/LICENSE-applications.txt. Details on the [ALPS license website](https://alps.comp-phys.org/mediawiki/index.php/Licensing).
55 
56 Use of `mps_optim`, `mps_tevol`, `mps_meas` or `mps_overlap` requires
57 citation of the ALPS %MPS paper \cite dolfi2014. Use of any ALPS program requires
58 citation of the ALPS paper \cite alps-paper.
59 
60 ## References
61 See [Bibliography](citelist.html) page.
62 
63 
64 [alps-web]: http://alps.comp-phys.org
65 [alps-mail]: comp-phys-alps-users@lists.comp-phys.org
void run(std::string const &chkp1, std::string const &chkp2)
Definition: main.cpp:52
Definition: mps.h:40