source: releases/2.1.4/README @ 658

Last change on this file since 658 was 39, checked in by awalther, 11 years ago

adapted directoy structure

File size: 3.0 KB
Line 
1
2     ADOL-C Version 2.1.0
3
4This new version of ADOL-C features new library functions for
5
6  - sparse Jacobians and sparse Hessians
7  - external differentiated functions
8  - optimal checkpointing
9  - adapted differentiation of fixed point iterations
10  - parallel differentiation of OpenMP-parallel loops
11   
12and many bug fixes.
13
14Furthermore the source code was adapted to allow a compilation with
15WINDOWS compilers. See file "INSTALL" for generic installation
16instructions and special instructions for the installation on a WINDOWS
17platform.
18 
19The complete documentation can be found in the subdirectory "doc".
20
21
22
23LOCAL INSTALLATION
24==================
25
261. Run configure with possibly using one of these options:
27
28  --prefix=PREFIX         install library and header files in PREFIX
29                          (default: ${HOME}/adolc_base)
30 
31  --with-sparse           build sparse drivers [default=no]
32
33  --with-openmp-flag=FLAG use FLAG to enable OpenMP at compile time
34                          [default=none]
35
36  --with-docexa           build documented examples [default=no]
37  --with-addexa           build additional examples [default=no]
38  --with-parexa           build parallel example [default=no], if yes
39                          -with-openmp-flag=FLAG required
40
41  --with-cflags=FLAGS     use CFLAGS=FLAGS (default: -O3 -Wall -ansi)
42  --with-cxxflags=FLAGS   use CXXFLAGS=FLAGS (default: -O3 -Wall)
43
442. Type make
45
463. Type make install
47
48   By default, `make install' will install all the files in ${PREFIX}/lib and
49   ${PREFIX}/include. You can specify another installation directory by using
50   the --prefix-option in the configure call.
51
52This procedure provides all makefiles required in the approporate directories.
53Execute 'configure --help' for more details on other available option.
54
55
56
57Nonlocal installation
58=====================
59
60As mentioned in INSTALL one can configure the adolc package to be installed
61in a different directory than "${HOME}/adolc_base" by using the "--prefix=PATH"
62configure option. This is typically used for global installations. Common PATHs
63are "/usr" and "/usr/local/", and others are known to be used. Fine control
64over the installation directories can be gained by supplying additional
65configure options. See "./configure --help" for details.
66
67Completing the installation by executing "make install" requires write
68permissions for all target directories. Make sure to have them or the result
69may be surprising otherwise.
70
71A global installation can be helpfull if many users need the library. By adding
72the library's path to "/etc/ld.so.conf" the usage of LD_LIBRARY_PATH and the
73"-L" link switch becomes unnecessary. In many cases, for instance for
74PATH=/usr/local, the use of the -I directive for compiling sources becomes
75unnecessary too.
76
77
78
79Examples
80========
81
82Examples must be configured to build by using the configure switches
83   --with-docexa or --with-addexa.
84They will never be installed by make install but can be found in the
85appropriate example subdirectory.
86
87
88
89
90Enjoy this new version!
91
Note: See TracBrowser for help on using the repository browser.