/[ff3d]/ff3d/README
ViewVC logotype

Diff of /ff3d/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4 by dobj, Wed Feb 19 13:48:27 2003 UTC revision 1.5 by delpinux, Mon Feb 24 16:27:13 2003 UTC
# Line 1  Line 1 
1          FreeFEM3D (aka ff3d) is a 3d version of FreeFEM.          FreeFEM3D (aka ff3d) is a 3d version of FreeFEM.
2    
 Licence issue:  
 -------------  
3    
4    Copyright (C) 2001 Stéphane Del Pino  0) Contents
5       ========
6    
7    0) Contents
8    1) Licence issue and Warranty
9    2) Description
10    3) Documentation
11    4) Getting the sources
12    5) Getting binaries
13    6) Compiling the code
14      a) Generalities
15      b) Mac OS-X
16      c) MS-Windows
17    7) More informations
18      a) Mailing lists
19      b) contact us
20    
21    
22    
23    1) License issue and Warranty
24       ==========================
25    
26      Copyright (C) 2001, 2002, 2003 Stéphane Del Pino
27    
28    ff3d is free software; you can redistribute it and/or modify    ff3d is free software; you can redistribute it and/or modify
29    it under the terms of the GNU General Public License as published by    it under the terms of the GNU General Public License as published by
# Line 19  Licence issue: Line 39  Licence issue:
39    along with this program; if not, write to the Free Software    along with this program; if not, write to the Free Software
40    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
41    
42  Description:  2) Description
43  -----------     ===========
44    
45  FreeFEM3D (aka ff3d) is a 3D solver of partial differential equations.  FreeFEM3D (aka ff3d) is a 3D solver of partial differential equations.
46  It is a member of the familly of the freefem programs (see  It is a member of the familly of the freefem programs (see
# Line 48  The goal of ff3d is to provide a good te Line 68  The goal of ff3d is to provide a good te
68  a research toolbox (the code is written in C++ and its design is such  a research toolbox (the code is written in C++ and its design is such
69  that new methods can be easily implemented).  that new methods can be easily implemented).
70    
 To compile :  
 You need g++ version 3., autoconf, libtools and bison  
71    
72  On MacOSX, we recommend to install fink  3) Documentation
73       =============
74    
75    A user documentation is available at
76            http://www.freefem.org/docs/freefem3dDoc.pdf
77    It is written in latex. Solver options are automagically generated
78    browsing the code.
79    
80    Documentation examples are given in the 'doc/doc-tests' directory.
81    
82    Developer documentation does not exist by now, but a doxygen tree is
83    browsable at
84            http://www.freefem.org/ff3d/doxygen/
85    
86    
87    4) Getting the sources
88       ===================
89    
90    Since ff3d is licensed under GNU GPL (see paragraph 1), it sources are
91    distributed. FreeFEM3D is a non-GNU project hosted by Savannah
92            http://savannah.nongnu.org
93    
94    Sources are archived using a CVS repository. To get them, one must
95    install cvs (see http://www.cvshome.org).
96    
97    Then the following two commandes will get the sources for you:
98      cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/ff3d login
99    [ just press enter when the password is asked ]
100      cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/ff3d co ff3d
101    
102    5) Getting binaries
103       ================
104    
105    If one does not want to get into the compiling task, binairies are
106    available. At the moment they are not automatically generated, so they
107    may not be up to date. Check them at:
108            http://www.freefem.org/ff3d/binaries.html
109    GNU/Linux, Mac-OS X and MS-Windows binaries are available.
110    
111    
112    6) Compiling the sources
113       =====================
114    
115      a) Generalities
116         ------------
117    
118    Note that g++-3.x is required to compile ff3d!
119    [ Previous versions (g++-2.x) compilers are NOT supported! ]
120    
121    The following softwares are required
122    - g++ (version >= 3)
123    - autoconf
124    - libtools
125    - bison
126    
127    The following are optional (but recommended)
128    - autogen
129    - vtk (version >= 4)
130    
131    The compilation procedure is the following. After getting the sources
132    go to the ff3d directory and execute
133            autoreconf -i
134    This will generate the 'configure' script.
135    One has now to execute it giving options
136            ./configure --help
137    will list them. Use the '--enable-debug' if you want to develop new
138    functionalities.
139    
140      b) Mac OS-X
141         --------
142    
143    To build sources, we recommand the usage of fink
144            http://fink.sourceforge.net/
145    This will help you in installing the required softwares.
146    
147      c) MS-Windows
148         ----------
149    
150    One has to install cygwin to compile ff3d. Get it at
151            http://cygwin.com/
152    
153    7) More informations
154       =================
155    
156      a) Mailing lists
157         -------------
158    
159    Four mailing lists are related to ff3d. They are also hosted by
160    Savannah. One can subscribe to them at
161            http://savannah.nongnu.org/mail/?group=ff3d
162    
163      b) contact us
164         ----------
165    
166    The best way to contact us, is to write at
167            ff3d-users@nongnu.org
168    
169    If you want to ask question non specific to ff3d, one can write email
170    to
171            freefem@ann.jussieu.fr
172    
173  --  --
174  Comments are welcome.  Comments are welcome.
175    
176      Project leader:
177            - Olivier Pironneau <Olivier.Pironneau@math.jussieu.fr>
178    
179      Developers:
180          - Stéphane Del Pino <Stephane.DelPino@math.jussieu.fr>          - Stéphane Del Pino <Stephane.DelPino@math.jussieu.fr>
181          - Cécile Dobrzynski <dobrzyns@ann.jussieu.fr>          - Cécile Dobrzynski <dobrzyns@ann.jussieu.fr>

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26