Merge lp:~nickpapior/siesta/chess into lp:~stephan-mohr-n/siesta/CheSS-branch

[Nick Papior]

Added the README_CHESS to the siesta.tex manual.

Additionally we should also add the flags for the CheSS flags in the manual. For instance see how the PEXSI library has gotten its documentation.

[Nick Papior (nickpapior)]

ping @albertog (added as reviewer so you can track it)

[Stephan Mohr (stephan-mohr-n)]

review: Approve

[Stephan Mohr (stephan-mohr-n)]

I can add the CheSS flags to the manual.

[Alberto Garcia (albertog)]

Good. I will try the compilation of the chess-suite on my Mac again and report back.

review: Approve

=== modified file 'Docs/siesta.tex'
--- Docs/siesta.tex	2016-12-27 11:11:09 +0000
+++ Docs/siesta.tex	2017-02-02 09:52:29 +0000
@@ -867,6 +867,26 @@
   LIBS += -Wl,--allow-multiple-definition -lpexsi_linux <>
 \end{shellexample}
 
+
+  \item[CheSS]%
+  \index{CheSS}%
+  \index{External library!CheSS}%
+  \siesta\ allows calculation of the electronic structure through the
+  use of the Order-N method \program{CheSS}\footnote{See
+      \url{https://launchpad.net/chess}.}. To enable this solver (see
+  \fdf{SolutionMethod}) one needs to first compile the
+  \program{CheSS}-suite and subsequently adding this to the
+  \file{arch.make}. Here \program{<build-dir>} is the build-directory
+  of the \program{CheSS} suite:  
+
+\begin{shellexample}
+  LIBS += -L<build-dir> -lCheSS-1 -lfutile-1 -lyaml
+  INCFLAGS += -I<build-dir>/install/include
+  FPPFLAGS += -DSIESTA__CHESS
+\end{shellexample}
+  \index{compile!pre-processor!-DSIESTA\_\_CHESS}
+
+  
   \item[flook]%
   \index{flook}%
   \index{External library!flook}%

=== modified file 'version.info'
--- version.info	2017-01-19 06:46:58 +0000
+++ version.info	2017-02-02 09:52:29 +0000
@@ -1,1 +1,1 @@
-trunk-596
+trunk-596--Chess-doc-1