Merge branch 'hotfix-3.07.3'
[felt.git] / INSTALL
blobce253557ca9124a7c43232de7d9edf3c51726f49
1 This is the INSTALL file for the version 3.x of FElt.  There have been
2 considerable changes since version 2.x, so please read this file.
4 If you have a binary release:
6     The default installation prefix is /usr/local.  Executables will
7     go into /usr/local/bin, manual pages into /usr/local/man, and the
8     remaining files into /usr/local/lib/felt.
10     If you want to change the installation prefix then you need to do
11     a "./configure --prefix=dir", where "dir" is your prefix.  You may
12     also wish to edit ./etc/Makefile.conf to change the individual
13     installation directories.
15     Once the installation directories are set, all you need to do is a
16     "make install" to perform the installation.  Any necessary
17     directories will be created.
20 If you are building from source:
22     First, read the README files.
24     You will need a C compiler and X11R5 or X11R6, including the
25     Athena widget set, to compile FElt.  FElt will also compile under
26     X11R4 under certain architectures, most notably SGI.
28     If you have gcc, we *strongly* recommend using it.  If you don't
29     have gcc then you may get all sorts of weird compile-time errors
30     about prototypes and include files.  Any warnings can probably be
31     ignored.  FElt should compile with the various native Sun
32     compilers.  Our experiences with overcoming several problems of
33     SGIs are included at the end of this file.
35     To configure FElt, do a "./configure" from the root of the
36     hierarchy.  On some systems, you may need to do a "sh configure".
37     The configure script should produce a list of defaults for your
38     system and create the ./etc/Makefile.conf file, which contains all
39     of the system specific information.  You can do a "./configure
40     --help" to find out how to pass options to the configure script.
41     You may also edit the ./etc/Makefile.conf file by hand.
43     The geompack library used for element generation is written in
44     Fortran, but C versions as converted by f2c are provided.  Using a
45     native Fortran compiler is recommended since it will probably
46     outperform the corresponding C code, but unfortunately,
47     determining what your specific Fortran libraries are is not a
48     simple process so unless you know exactly what you are doing it's
49     not worth bothering with.  You don't need to have the f2c
50     libraries to use the converted code.  If you want to use native
51     Fortran on HP-UX, then there are some hints for you in the special
52     section on HP-UX at the end of this file.
54     You can now do a "make" or a "make all" to build the entire package.
55     The various targets are:
57     make all
58         builds all executables and libraries
60     make clean
61         removes all executables, libraries, and object files
63     make clobber
64         same as a make clean, but also removes other files that can be
65         regenerated if you have the correct versions of flex and bison
67     make install
68         installs the executables, manual pages, and defaults files
70     make depend
71         at present, does nothing
73     make test
74         performs a simple test comparing the output from felt on
75         ./etc/Tests/mixed_dist.felt with the known answers; the
76         answers may vary slightly due to floating point round-off
77         (available only from the root directory)
79     The entire package has been compiled and tested under SunOS (using
80     gcc and Sun's native compilers) and Linux (1.0 and 1.1 kernels).
81     Earlier releases compiled and ran on SystemV386 (R3.2.2 using
82     gcc), various SGI machines, HP-UX 8.0 and 9.0 (using HP's cc and
83     gcc), and DEC (using both OSF/1 and Ultrix) and IBM (AIX)
84     workstations.  There is no reason this one shouldn't do the same.
86     We personally prefer the 3D Athena widget set; if it's available
87     on your system and you want to use it, the only thing that we
88     recommend that you change are the application defaults ... simply
89     uncomment the 3D stuff in the file Velvet.ad in the ./src/Velvet
90     directory (and comment the 2D stuff).
92     Additional information about building and administering FElt is
93     available in Appendix A of the User's Guide and Reference manual
94     (available separately).  You'll definitely want to read this if
95     you plan on installing and actively using the system.
98 ---------------------------------------------------------------------------
99 Special notes for SGI users:
100 ---------------------------------------------------------------------------
102 Ok, we don't recommend it, but we have had some success at building
103 FElt on Irix 4.0.x with the native compiler (and X11R4, which I
104 believe is the standard X that is included with 4.0.x).  This is the
105 kind of thing where your mileage will definitely vary - we don't
106 really have a lot of experience with Irix and have no clue as to how
107 consistent this will be across different versions and installations.
109 In FElt-3.xx/lib/Felt/lexer.c you need to comment out the prototypes for
110 malloc and free.  There are two places where definitions occur, you need
111 to change the one like:
113 char *malloc();
114 int free();
116 to look like:
118 /* char *malloc();
119 int free() ; */
121 Next, copy /usr/include/stdlib.h to FElt-3.xx/include.  In the copied
122 file (FElt-3.xx/include/stdlib.h), comment out the line that looks like
124 extern int      system(const char *);
126 It's probably somewhere around line 102, it should now look like
128 /* extern int   system(const char *); */
131 --------------------------------------------------------------------------
132 Special notes for HPUX 9.0x, 700 series
133 --------------------------------------------------------------------------
135 If you want to use the native Fortran compiler then from the toplevel
136 FElt directory, do 
138 rm -f ./lib/Geompack/*.c
140 and add the following variables to ./etc/Makefile.conf
142 FC      = fort77
143 FCOPTS  = -O