~jose-soler/siesta/unfolding

« back to all changes in this revision

Viewing changes to Docs/siesta.tex

  • Committer: Alberto Garcia
  • Date: 2006-02-13 14:43:00 UTC
  • mfrom: (unknown (missing))
  • Revision ID: Arch-1:siesta@uam.es--2005%siesta-devel--reference--1.5--patch-36
More documentation and fixes for Examples, Tutorials, and Util
* Expanded and created README files for Examples, Tutorials, and Util
* Cleaned up Denchar (removed Tests directory from distribution) 
  and Vibra (new compilation scheme, using the top-level arch.make)
* Fixed end-of-file handling in sies2arc.


Show diffs side-by-side

added added

removed removed

Lines of Context:
269
269
Siesta}, make sure you have all the extra support libraries ({\tt MPI,
270
270
scalapack, blacs...}). Type {\tt make}. The executable should work
271
271
for any job (This is not exactly true, since some of the parameters in
272
 
the atomic routines are still hardwired (see {\tt Src/atmparams.f}) ,
 
272
the atomic routines are still hardwired (see {\tt Src/atmparams.f}),
273
273
but those would seldom need to be changed.)
274
274
 
275
275
\subsection{Running the program}
276
276
 
277
 
Some example FDF files are provided in the {\tt Examples}
278
 
directory. This directory contains basically the {\tt .fdf}
279
 
files and the pseudopotential generation input files. A faster way to
280
 
test your installation of {\sc Siesta} is implemented in directory
281
 
{\tt Src/Tests}\index{Tests}. On the other hand, at some point you
282
 
will have to generate your own pseudopotentials and run your own jobs.
 
277
A fast way to test your installation of {\sc Siesta} and get a feeling
 
278
for the workings of the program is implemented in directory
 
279
{\tt Tests}\index{Tests}. In it you can find several subdirectories
 
280
with pre-packaged FDF files and pseudopotential references. Everything
 
281
is automated: after compiling {\sc Siesta} you can just go into any
 
282
subdirectory and type {\tt make}. The program does its work in
 
283
subdirectory {\tt work}, and there you can find all the resulting
 
284
files. For convenience, the output file is copied to the parent
 
285
directory. A collection of reference output files can be found in {\tt
 
286
  Tests/Reference}. Please note that small numerical and
 
287
formatting differences are to be expected, depending on the compiler.
283
288
 
284
 
Probably the simplest to start with is the water-molecule
285
 
example. It is advisable to create independent directories for each
286
 
job, so that everything is clean and neat, and out of the {\tt siesta}
287
 
directory, so that one can easily update version by replacing the
288
 
whole {\tt siesta} tree. Go to your favorite working directory and:
 
289
Other examples are provided in the {\tt Examples} directory. This
 
290
directory contains basically the {\tt .fdf} files and the
 
291
pseudopotential generation input files. Since at some point you will
 
292
have to generate your own pseudopotentials and run your own jobs, we
 
293
describe here the whole process by means of the simple example of the
 
294
water-molecule. It is advisable to create independent directories for
 
295
each job, so that everything is clean and neat, and out of the {\tt
 
296
siesta} directory, so that one can easily update version by replacing
 
297
the whole {\tt siesta} tree. Go to your favorite working directory
 
298
and:
289
299
 
290
300
{\tt \$ mkdir h2o}
291
301
 
308
318
{\tt \$ make}
309
319
 
310
320
\noindent
311
 
Now the pseudopotential-generation program, called atm, 
312
 
should be compiled.
 
321
Now the pseudopotential-generation program, called {\tt atm}, 
 
322
should be compiled (you might want to change the definition of
 
323
the compiler in the makefile).
313
324
 
314
325
{\tt \$ cd Tutorial/O}
315
326
 
647
658
gives orbitals better adapted to ionic situations in the condensed
648
659
systems.
649
660
 
650
 
  More information about basis sets can be found in the proposed literature.
 
661
  More information about basis sets can be found in the proposed
 
662
  literature.
 
663
 
 
664
The directory {\tt Tutorials/Bases} in the main {\sc Siesta
 
665
  distribution} contains some tutorial material for the generation of
 
666
basis sets and KB projectors.
651
667
 
652
668
\section{COMPILING THE PROGRAM}
653
669
 
663
679
operating sistems.\index{platforms}\index{architectures}
664
680
If none of these fit your needs, you will have to prepare
665
681
one on your own. 
666
 
By typing 
 
682
The command
667
683
 
668
684
\noindent 
669
685
{\tt \$ ./configure} 
670
686
 
671
687
\noindent
672
 
the autoconf utility will query your 
673
 
computer and come up with a reasonably working {\tt arch.make}.
674
 
It can be then further modified by the user to include optimisation flags
675
 
for the compiler etc.
676
 
Note that some systems require running a program such as
677
 
ranlib\index{ranlib} to index object code libraries.
678
 
Once you have chosen a {\tt .make} file from the {\tt Src/Sys}
679
 
directory, or have generated your own {\tt arch.make},
680
 
just compile using the {\tt make} utility, as usual.
 
688
 will start an automatic scan of your system and try to build
 
689
an {\tt arch.make} for you. Please note that the configure script
 
690
might need some help in order to find your Fortran compiler, and that
 
691
the created arch.make may not be optimal, mostly in regard to compiler
 
692
switches, but the process should provide a reasonable working
 
693
file. Type {\tt ./configure --help} to see the flags understood by the
 
694
script, and take a look at the {\tt Src/Confs} subdirectory for some
 
695
examples of their explicit use. You can fine tune {\tt arch.make}
 
696
by looking at the examples in the {\tt Src/Sys} subdirectory.
 
697
If you intend to create a parallel version of {\sc
 
698
Siesta}, make sure you have all the extra support libraries ({\tt MPI,
 
699
scalapack, blacs...}). 
 
700
 
 
701
After {\tt arch.make} is ready, ype {\tt make}. The executable should work
 
702
for any job (This is not exactly true, since some of the parameters in
 
703
the atomic routines are still hardwired (see {\tt Src/atmparams.f}) ,
 
704
but those would seldom need to be changed.)
681
705
 
682
706
\section{INPUT DATA FILE}
683
707