Straw man manual outline

git-svn-id: https://subversion.assembla.com/svn/qmcdev/trunk@6462 e5b18d87-469d-4833-9cc0-8cdfa06e9491
This commit is contained in:
Paul Kent 2015-05-23 21:51:11 +00:00
parent b376e831f7
commit 53e6e1dfa5
23 changed files with 129 additions and 0 deletions

6
manual/analysis.tex Normal file
View File

@ -0,0 +1,6 @@
\chapter{Analysing QMCPACK data}
\section{Using the qmca tool}
\section{Densities and spin-densities}
\section{Energy densities}

1
manual/backflow.tex Normal file
View File

@ -0,0 +1 @@
\section{Backflow wavefunctions}

1
manual/dmc.tex Normal file
View File

@ -0,0 +1 @@
\section{Diffusion Monte Carlo}

View File

@ -0,0 +1,2 @@
\chapter{Hamiltonian and Observables}

3
manual/installation.tex Normal file
View File

@ -0,0 +1,3 @@
\chapter{Obtaining and installing QMCPACK}
Don't forget to patch QE!

10
manual/introduction.tex Normal file
View File

@ -0,0 +1,10 @@
\chapter{Introduction}
QMCPACK is an open-source, high-performance electronic structure code that implements numerous Quantum Monte Carlo algorithms.
Test of the bibliography\cite{CeperleyAlderPRL1980}.
\section{Support}
\section{Performance}
\section{Open source license}
\section{Contributing to QMCPACK}

2
manual/jastrow.tex Normal file
View File

@ -0,0 +1,2 @@
\section{Jastrow Factors}

View File

@ -0,0 +1 @@
\section{Multideterminant wavefunctions}

2
manual/opt.tex Normal file
View File

@ -0,0 +1,2 @@
\section{Wavefunction Optimization}

1
manual/particleset.tex Normal file
View File

@ -0,0 +1 @@
\section{Specifying the particle set}

12
manual/qmc.bib Normal file
View File

@ -0,0 +1,12 @@
@article{CeperleyAlderPRL1980,
Author = {Ceperley, D. M. and Alder, B. J.},
Issue = {7},
Journal = {Physical Review Letters},
Month = {Aug},
Pages = {566--569},
Publisher = {American Physical Society},
Title = {Ground State of the Electron Gas by a Stochastic Method},
Volume = {45},
Year = {1980},
url = {http://dx.doi.org/10.1103/PhysRevLett.45.566}
}

2
manual/qmc_methods.tex Normal file
View File

@ -0,0 +1,2 @@
\chapter{Quantum Monte Carlo Methods}
General description of which QMC methods are available and documented.

46
manual/qmcpack_manual.tex Normal file
View File

@ -0,0 +1,46 @@
\documentclass[11pt]{report}
\usepackage{amsmath}
\usepackage{makeidx}
\usepackage{ifpdf}
\usepackage{fancyhdr}
%\usepackage{hyperref} %for urls
\usepackage{url}
\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
\begin{document}
\input{title.tex}
\newpage
\tableofcontents
\newpage
\input{introduction}
\input{installation}
\input{running}
\chapter{Specifying the system to be simulated}
\input{simulationcell}
\input{particleset}
\chapter{Trial wavefunction specification}
\input{spo}
\input{jastrow}
\input{multideterminants}
\input{backflow}
\input{hamiltonianobservable}
\input{qmc_methods}
\input{vmc}
\input{opt}
\input{dmc}
\input{reptation}
\input{analysis}
\newpage
\chapter{References}
%\begingroup % Avoid "References" section title
%\renewcommand{\section}[2]{}%
\bibliographystyle{ieeetr}
\bibliography{qmc}
%\endgroup
\end{document}

1
manual/reptation.tex Normal file
View File

@ -0,0 +1 @@
\section{Reptation Monte Carlo}

10
manual/running.tex Normal file
View File

@ -0,0 +1,10 @@
\chapter{Running QMCPACK}
\section{Command line options}
\section{Input files}
\section{Output files}
scalar.dat\\
dmc.dat\\
stat.h5\\
config.h5
\section{Running in parallel}
considerations for mpi, threads, gpu.

View File

@ -0,0 +1 @@
\section{Specifying the simulation cell}

8
manual/spo.tex Normal file
View File

@ -0,0 +1,8 @@
\section{Single-particle orbitals}
\include{spo_spline}
\include{spo_gaussian}
\include{spo_pw}
\include{spo_heg}

1
manual/spo_gaussian.tex Normal file
View File

@ -0,0 +1 @@
\subsection{Gaussian basis sets}

2
manual/spo_heg.tex Normal file
View File

@ -0,0 +1,2 @@
\subsection{Homogeneous electron gas}

1
manual/spo_pw.tex Normal file
View File

@ -0,0 +1 @@
\subsection{Plane-wave basis sets}

1
manual/spo_spline.tex Normal file
View File

@ -0,0 +1 @@
\subsection{Spline basis sets}

14
manual/title.tex Normal file
View File

@ -0,0 +1,14 @@
\begin{center}
\HRule\\[0.5 cm]
{\huge \bfseries QMCPACK \\[0.5cm]}
{\large User's Guide and Developer's Manual\\[1cm]}
\HRule
\vfill
{\large \today}
\end{center}

1
manual/vmc.tex Normal file
View File

@ -0,0 +1 @@
\section{Variational Monte Carlo}