From 274b3b7e21c652e1952c41a2c84af9f6af4af48d Mon Sep 17 00:00:00 2001 From: QuanSheng Wu Date: Mon, 15 Oct 2018 11:23:29 +0200 Subject: [PATCH] added INSTALl illustration --- INSTALL | 31 +++++++++++++++++++++++++++++++ soc/Makefile.intel-mpi | 2 +- soc/main.f90 | 1 + 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 INSTALL diff --git a/INSTALL b/INSTALL new file mode 100644 index 00000000..88272005 --- /dev/null +++ b/INSTALL @@ -0,0 +1,31 @@ +WannierTools is written in Fortran90. Eventually, Fortran compiler is required to install it. At present, +we only support the installation on Mac or Linux or other Unix like systems. + +1. Download the package +a. You can download the latest develop branch by using "git clone" +git clone https://github.com/quanshengwu/wannier_tools.git +b. You could also download the release version on page +https://github.com/quanshengwu/wannier_tools/releases + +2. After the download, uncompress it if necessary. The source file is included in the soc/ folder. +The executable binary will be copied to bin/ folder after compilation. There are several examples +in the examples/ folder. The symmetrization module is in the wannhr_symm/ folder which is an +independent python package. + +3. Go into the folder soc/ for the compilation. We prepared several Makefiles for different usage. +Please copy the one that you need into Makefile like + +cp Makefile.intel-mpi Makefile + + +4. Modify Makefile +a. Choose the lapack and Blas library by setting LIBS. +b. if you want to use mpi, please add -DMPI as an option of compiler F90. + +5. Make it by typing + +make + +6. After the compilation, binary wt.x will be generated and copied to ../bin/ folder. + +7. About the usage, please visit website www.wanniertools.com diff --git a/soc/Makefile.intel-mpi b/soc/Makefile.intel-mpi index cafb6e8b..22f90504 100644 --- a/soc/Makefile.intel-mpi +++ b/soc/Makefile.intel-mpi @@ -14,7 +14,7 @@ F90 = mpiifort -fpp -DMPI INCLUDE = -I${MKLROOT}/include WFLAG = -warn all -OFLAG = -g -traceback -static-intel +OFLAG = -O3 -g -traceback -static-intel FFLAG = $(OFLAG) $(WFLAG) LFLAG = $(OFLAG) diff --git a/soc/main.f90 b/soc/main.f90 index 4d8b1734..76a92c3b 100644 --- a/soc/main.f90 +++ b/soc/main.f90 @@ -14,6 +14,7 @@ ! Jan 25 2015 by Q.S.Wu at ETH Zurich ! version 2.2.1 At EPFL, Switzerland, Sep. 14. 2017 ! version 2.4.0 At EPFL, Switzerland, Aug. 31. 2018 +! version 2.4.1 At EPFL, Switzerland, Oct. 15. 2018 ! wuquansheng@gmail.com ! Copyright (c) 2017 QuanSheng Wu. All rights reserved. !--------+--------+--------+--------+--------+--------+--------+------!