fixed nlsop for packaging ..
[physik/nlsop.git] / README
1 nlsop
2 #####
3
4 requirements (including headers):
5 ---------------------------------
6
7 - directfb api (http://www.directfb.org) for visualization only
8
9 - /dev/urandom
10
11 - ncurses
12
13 - fftw3 (http://fftw.org), my own discrete fourier transform api is buggy.
14
15 - my own minimal api. you can get it via cvs:
16
17   cvs -d:pserver:anonymous@hackdaworld.org:/my-code co api
18
19   you should downlaod it parllel to your nlsop dir, or use configure
20   option to specify the location instead.
21
22 install (nlsop):
23 ----------------
24
25 ./configure &&
26 make -f Makefile links &&
27 make -f Makefile nlsop
28
29 install other tools:
30 --------------------
31
32 make links
33 make dft linescan nlsop_make_cryst nlsop_create_cbox
34 (no install target)
35
36 run (nlsop):
37 ------------
38
39 (use '-h' to see the individual options of every binary)
40
41 nlsop_server:
42
43   install and run the binary on a stable, well connected host with enough
44   disk space for the nlsop save files.
45
46 nlsop_client:
47
48   install and run it on a number of nodes you want to do the actual
49   calculation on.
50
51 nlsop_gui:
52
53   run it to connect to the server to add jobs or get a status information
54   of the current jobs and clients.
55
56 nlsop:
57
58   use this for visualizing/converting/researching the save files.
59   you may also use it for a non distributed calculation.
60
61
62 --
63
64 have fun, frank
65