quantum-espresso/Doc
giannozz d5a4b5c192 tetrahedra + noncolinear spin fixed, courtesy of Yurii Timrov
git-svn-id: http://qeforge.qe-forge.org/svn/q-e/trunk/espresso@7551 c92efa57-630b-4861-b058-cf58834340f0
2011-03-07 10:54:10 +00:00
..
ChangeLog.cp documentation update 2004-11-25 15:15:26 +00:00
ChangeLog.old Minor updates to documentation 2008-05-14 13:04:58 +00:00
ChangeLog.pw Support for mac-osx added (contributed by Pascal Thibaudeau) 2004-08-09 16:35:51 +00:00
INPUT_Gamma Minor updates to documentation 2010-04-28 18:52:18 +00:00
INPUT_WFDD Documentation for wfdd added (manu) 2006-02-14 16:06:43 +00:00
INPUT_XSPECTRA Modifications in the INPUT_XSPECTRA instruction file: 2010-04-02 04:14:53 +00:00
Makefile image type changed from gif to png in latex2html commands. 2010-10-06 10:42:55 +00:00
README Minor updates to documentation 2010-04-28 18:52:18 +00:00
README.AUTOPILOT Adding Autopilot Feature Suite 2005-08-24 14:23:09 +00:00
constraints_HOWTO.tex Documentation updated 2010-02-13 11:52:02 +00:00
democritos.pdf Dodumentation updated 2010-03-18 21:56:54 +00:00
democritos.png Documentation and Democritos logo updated 2010-03-16 16:41:33 +00:00
developer_man.tex Minor dpcumentation update 2010-11-26 16:36:07 +00:00
eps_man.tex - manual for epsilon PP, from Andrea Benassi 2007-09-04 08:23:16 +00:00
nomefile.upf *** empty log message *** 2005-11-14 09:37:10 +00:00
quantum_espresso.pdf Added item for a last-minute bug - still waiting for contributions to 2009-07-14 17:01:59 +00:00
quantum_espresso.png User Guide is back...presently only the introduction, which was updated 2009-04-28 10:41:51 +00:00
release-notes tetrahedra + noncolinear spin fixed, courtesy of Yurii Timrov 2011-03-07 10:54:10 +00:00
user_guide.tex Minor glitches in documentation 2011-02-18 18:26:11 +00:00

README

Available documentation for the Quantum-ESPRESSO package in Doc/
(additional documentation is available from the QE wiki:
http://www.quantum-espresso.org/wiki/index.php/Main_Page)

The following files are always present in the CVS repository:

release-notes      What is new in the current release + list of fixed bugs
                   (only those found in some official release)

user-guide.tex     User guide
developer-man.tex  Developers' manual
INPUT_Gamma        Documentation of input data for the specialized phonon code
                   (Gamma-only and q=0 phonons only) phcg.x
INPUT_WFDD         Input data doc for dynamics with Wannier functions (cp.x)
INPUT_XSPECTRA     INput data doc for X-ray adsorption spectra (xspectra.x)
eps_man.tex        Documentation for code epsilon.x, performing
                   dielectric function calculation with RPA
README.AUTOPILOT   Notes on the "autopilot" feature, by Targacept, Inc.
nomefile.upf       Naming convention for UPF pseudopotentials
                   The UPF format is described in the Quantum ESPRESSO wiki,
                   in page "Unified_pseudopotential_format)xr"
constraints_HOWTO.tex
                   Documentation for constraints
ChangeLog.old      ChangeLog for the Quantum-ESPRESSO suite after aug. 2004
                   NO LONGER UPDATED - see below for the updated version
ChangeLog.pw       ChangeLog before aug 2004 for PWscf
ChangeLog.cp       ChangeLog before aug 2004 for CP

The following files are present in the released version 
The first two are obtained by typing "make log" in the root directory
The second two are obtained using pdflatex

ChangeLog          Updated ChangeLog, text file
ChangeLog.html     As above, html file
user-guide.pdf     User guide, printable version
developer-man.pdf  Developers' manual, printable version

The following files are present in the released version (obtained 
from the "helpdoc" utility: go into the ../doc-def/ directory, type
"make all". Note that "tcl", "tcllib", "xsltproc" are needed)

INPUT_*.*        Description of input parameters (text and html) for:
      CP         Car-Parrinello molecular dynamics code (cp.x)
      CPPP       Car-Parrinello postprocessing (cppp.x)
      PW         PWscf self-consistent code (pw.x)
      PP         Postprocessing code (pp.x)
      BANDS      Band reordering and plotting utility (bands.x)
      PROJWFC    Projection over atomic wfcs (projwave.x)
      DOS        Density of state calculation (dos.x)
      PH         Phonon calculations (ph.x)
      GIPAW      NMR chemical shifts with GIPAW (gipaw.x)
      Gamma      Normal-mode calculations (phcg.x)
      D3         3rd-order energy derivatives (d3.x)
      PWCOND     Ballistic conductance (pwcond.x)
      pw_export  pw_export utility (pw_export.x)

Documentation for the "atomic" pseudopotential generation code 
can be found in directory ../atomic_doc/

All the material included in this distribution is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later version.

These programs are distributed in the hope that they will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
675 Mass Ave, Cambridge, MA 02139, USA.