quantum-espresso/Doc
giannozz 6c40185885 - outdir is set by default to the value of the $ESPRESSO_TMPDIR
environment variable, or to './' (as before) if this is not set
- pseudo_dir is set by default to the value of $ESPRESSO_PSEDIR,
  to $HOME/espresso/pseudo/ otherwise
- documentation updated to reflect the new defaults
Note that the 'capture' of $HOME/pw/pseudo using a call to 'getenv'
was already present in pwscf but it was not working (pseudo_dir was
overwritten) so nothing susceptible to create new problems was added.


git-svn-id: http://qeforge.qe-forge.org/svn/q-e/trunk/espresso@3309 c92efa57-630b-4861-b058-cf58834340f0
2006-08-08 18:05:16 +00:00
..
BUGS Documentation updated 2006-06-01 09:58:21 +00:00
CREDITS Added support for Intel MKL v.8 FFTs (courtesy of Nicolas Lacorne). 2006-06-23 15:47:59 +00:00
ChangeLog Documentation updated 2005-10-13 13:36:51 +00:00
ChangeLog.cp documentation update 2004-11-25 15:15:26 +00:00
ChangeLog.pw Support for mac-osx added (contributed by Pascal Thibaudeau) 2004-08-09 16:35:51 +00:00
INPUT.HOWTO Documentation updated 2006-04-03 13:44:00 +00:00
INPUT_BANDS Documentation of bands.x . 2005-11-07 11:11:10 +00:00
INPUT_CP - outdir is set by default to the value of the $ESPRESSO_TMPDIR 2006-08-08 18:05:16 +00:00
INPUT_CPPP - new flag documented 2006-07-10 15:12:07 +00:00
INPUT_CPVIB updated documentation. [silviu] 2005-12-02 17:10:54 +00:00
INPUT_D3 Doc update 2005-05-20 07:56:33 +00:00
INPUT_DOS Doc update 2005-05-20 07:56:33 +00:00
INPUT_EFG Add input array rc in efg.x to specify the radius of the augmentation region 2004-10-10 16:22:05 +00:00
INPUT_Gamma Misc documentation update 2005-12-14 09:34:32 +00:00
INPUT_PH Calculation of finite (imaginary) frequency polarizability added. 2006-03-30 09:43:38 +00:00
INPUT_PP Documentation updated 2006-05-26 14:40:50 +00:00
INPUT_PROJWFC Doc update 2005-05-20 07:56:33 +00:00
INPUT_PW - outdir is set by default to the value of the $ESPRESSO_TMPDIR 2006-08-08 18:05:16 +00:00
INPUT_PWCOND Minor documentation update 2005-10-06 18:17:56 +00:00
INPUT_WFDD Documentation for wfdd added (manu) 2006-02-14 16:06:43 +00:00
README Documentation updated 2005-11-09 17:10:06 +00:00
README.AUTOPILOT Adding Autopilot Feature Suite 2005-08-24 14:23:09 +00:00
constraints_HOWTO.tex Doc updated. Added a mini howto that explains how to implement additional constrait types. 2005-12-21 20:27:51 +00:00
democritos.eps added postscript figures 2004-08-10 18:04:11 +00:00
democritos.png Support for mac-osx added (contributed by Pascal Thibaudeau) 2004-08-09 16:35:51 +00:00
eps_man.tex - updated documentation for "epsilon" post-processing 2006-07-04 16:26:19 +00:00
nomefile.upf *** empty log message *** 2005-11-14 09:37:10 +00:00
pwscf.eps added postscript figures 2004-08-10 18:04:11 +00:00
pwscf.png Support for mac-osx added (contributed by Pascal Thibaudeau) 2004-08-09 16:35:51 +00:00
refman.tex Minor documentation update 2006-07-06 13:26:26 +00:00
restart documentation updated 2006-07-05 09:29:55 +00:00
smd.tex - SMD example and documentation updated. 2005-09-07 15:33:57 +00:00
users-guide.tex documentation updated 2006-07-27 12:54:09 +00:00

README

This is the available documentation for the Quantum-ESPRESSO package:

users-guide.tex    User's Guide for Quantum-ESPRESSO
                   Requires "html.sty" (from latex2html package): if
                   not available, comment "\usepackage{html}" and
                   uncomment "\def\htmladdnormallink#1#2{#1}" near the
                   beginning of the file.

refman.tex         Reference (technical) manual for PWscf: little more
                   than a template at present

smd.tex            Notes on the usage of the "Strings Method", by Y. Kanai
README.AUTOPILOT   Notes on the "autopilot" feature, by Targacept, Inc.
nomefile.upf       Naming convention for UPF pseudopotentials
                   The UPF format is described in ../upftools/UPF
restart            Describes the format of the new output data file
 
INPUT_CP         Input parameters for CP 
INPUT.HOWTO      Hints on how to choose simulation parameters for
                 CP with Car-Parrinello dynamics
INPUT_PW         Input parameters for PWscf (pw.x)
INPUT_PP         Input parameters for postprocessing (pp.x)
INPUT_PROJWFC    Input parameters for projection over atomic wfcs (projwave.x)
INPUT_DOS        Input parameters for density of state calculation (dos.x)
INPUT_PH         Input parameters for phonon calculations (ph.x)
INPUT_Gamma      Input parameters for normal-mode calculations (phcg.x)
INPUT_D3         Input parameters for 3rd-order derivatives (d3.x)
INPUT_EFG        Input parameters for electric-field gradient calc (efg.x)
INPUT_PWCOND     Input parameters for ballistic conductance (pwcond.x)

ChangeLog       ChangeLog for the Quantum-ESPRESSO suite after aug. 2004
                NO LONGER UPDATED: use script "cvs2cl.pl" in the main
                directory to get an updated ChangeLog from CVS
ChangeLog.pw    ChangeLog before aug 2004 for PWscf
ChangeLog.cp    ChangeLog before aug 2004 for CP

BUGS            List of bugs fixed - only bugs that have been present
                in some "official" release are listed
CREDITS         Who did what

pwscf.png, pwscf.eps, democritos.png, democritos.eps
                PWscf and DEMOCRITOS logos -- included from users-guide.tex

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.