Initial release of Maemo 5 port of gnuplot
[gnuplot] / docs / old / README.fit
1 Welcome to GNUFIT - an extension to GNUPLOT
2 ===========================================
3
4 Version 1.2
5
6 gnuplot has been widely established as a powerful tool to do data and
7 function plots. For the scientific use one additionally often needs
8 a nonlinear least squares fitting procedure to combine a model function
9 to measured data. This is introduced by GNUFIT. GNUFIT is a real extension
10 of GNUPLOT that means, it covers all features of GNUPLOT and adds some new
11 ones.
12
13 GNUFIT incorporates a nonlinear least squares fit mechanism into GNUPLOT. The
14 fit uses the Marquardt-Levenberg-algorithm for fitting and the GNUPLOT
15 function evaluation mechanism for calculation. Thus it remains relatively
16 small. It offers all advantages of fitting every rather complex-formulated
17 function you can create with GNUPLOT (including complex calculation).
18
19
20 GNUFIT is available as follows:
21
22     gnufit12.tar.gz     All new sources and diff's against gnuplot3.4 and
23                         gnuplot3.5, readmes, demos and installation hints
24                         needed to compile and run GNUFIT on your machine,
25                         provided that you already have the original
26                         gnuplot sources.
27
28     gft12dos.zip        DOS executables 
29
30
31 A description of the files in gnufit12.tar.gz
32 =================================================
33
34 readme.1st      This file - Overview
35 compile.fit     Some hints for the compilation on various platforms
36 install         UNIX shellscript to do the patches
37 install.bat     DOS Batchfile for the same purpose
38 credits         A list of people who helped me making GNUFIT stable
39
40 fit.c           the main fitting routines
41 fit.h           Interface to fit.c
42 matrix.c        some matrix algebra needed in fit.c
43 matrix.h        interface to matrix.c
44 type.h          commonly used types
45 linux.trm       terminal driver for LINUX
46
47 patches.35      Context diff's of the GNUFIT sources against the GNUPLOT3.5
48                 sources. They have been done using
49                 diff -cr oldfile newfile >> patches.35
50                 and may be applied to the gnuplot sources by the patch program.
51                 This is done also by the install-script.
52 patches.34      Same story based on gnuplot3.4 for the case of incompatibilities
53
54
55
56 Installation procedure:
57 =======================
58
59
60 1)  Start from the directory */diff which has been generated by untaring
61     this package.
62
63 2)  Create a directory (e.g. called 'gnufit') and place a copy of the gnuplot3.2
64     sources (including the subdirs) in it. Make sure that it is writable.
65     gnuplot sources may be obtained from ftp.dartmouth.edu in
66     /pub/gnuplot
67
68 3)  If you're not working under DOS or UNIX, create an appropriate
69     scriptfile like has been done in 'install' (UNIX) or 'install.bat' (DOS).
70     The only commandline-parameter of the scriptfile is the directory you
71     just created (gnufit).
72
73 4)  Execute the scriptfile. This will copy the necessary sources to 'gnufit'
74     and do the needed patches to the gnuplot sources. Finally it changes
75     the actual working directory.
76
77     e.g.    install ~/gnufit
78
79 5)  Look at the file 'compile.fit' for compilation hints on your system.
80     That may require small changes to the appropriate makefile, e.g. for
81     compiler selection and compiler switches.
82
83 6)  Check the compilation hints for gnuplot in 'readme.ins' and execute them.
84
85 GNUFIT has been successfully tested and compiled on the following
86 operating systems:
87
88     DOS (MSC 6.0), OS/2, SunOS, HPUX, IBM/RS6000, DEC Ultrix, DG/UX, LINUX
89     Amiga
90
91 Only the compilers mentioned in 'compile.fit' have been used.
92 For compatibility purposes with other scripts written for GNUPLOT, the
93 executables' filenames are still left 'gnuplot', 'gnuplot.exe' etc.
94 The starting message however distinguishes between GNUPLOT and GNUFIT.
95 To get a successful compilation on other systems there may be minor patches
96 to the sources necessary. If you succeed in adding a new platform, please
97 generate diff's of the modified sources and send them to me. They may be
98 included into a further release of GNUFIT.
99
100
101
102 What is planned?
103 ================
104
105 This will probably be the last release of GNUFIT. Not because I think it's
106 rubbish but because it will be included as an internal part into the next 
107 official release of gnuplot. Development is under way!
108
109 Please send any comments, bug-reports, implementation reports and
110 improvement proposals to gnuplot-bugs@lists.sourceforge.net
111
112 ***************************************************************************
113
114 Carsten Grammes
115 Saarbruecker Str. 47
116 D-66292 Riegelsberg
117 Germany
118
119 Internet Mail-Address:      cagr@rz.uni-sb.de
120 Telephone                   49 6897 935 0
121 Telefax                     49 6897 935 100
122