source: trunk/README

Last change on this file was 772, checked in by kulshres, 4 months ago

Squashed merge from git master into svn

at master commit 9d229164475f75c718d8ad13d744cc329c6607bd

all build files need to be regenerated

File size: 3.7 KB
Line 
1
2     ADOL-C
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  - Lie derivatives of scalar, vector and covector fields
12
13and many bug fixes.
14
15Furthermore the source code was adapted to allow a compilation with
16WINDOWS compilers. See file "INSTALL" for generic installation
17instructions and special instructions for the installation on a WINDOWS
18platform.
19
20The complete documentation can be found in the subdirectory "doc".
21
22
23
24LOCAL INSTALLATION
25==================
26
271. Type autoreconf -fi
28
292. Run configure with possibly using one of these options:
30
31  --prefix=PREFIX         install library and header files in PREFIX
32                          (default: ${HOME}/adolc_base)
33 
34  --enable-sparse           build sparse drivers [default=no]
35
36  --with-openmp-flag=FLAG use FLAG to enable OpenMP at compile time
37                          [default=none]
38
39  --enable-docexa           build documented examples [default=no]
40  --enable-addexa           build additional examples [default=no]
41  --enable-parexa           build parallel example [default=no], if yes
42                          -with-openmp-flag=FLAG required
43
44  --with-cflags=FLAGS     use CFLAGS=FLAGS (default: -g -O2)
45  --with-cxxflags=FLAGS   use CXXFLAGS=FLAGS (default: -g -02 -std=c++11)
46
47  --with-boost=BOOST_PATH path to the compiled boost library, otherwise
48                          the system one is chosen by default (if exists)
49
503. Type make
51
524. Type make install
53
54   By default, `make install' will install all the files in ${PREFIX}/lib and
55   ${PREFIX}/include. You can specify another installation directory by using
56   the --prefix-option in the configure call.
57
58This procedure provides all makefiles required in the approporate directories.
59Execute 'configure --help' for more details on other available option.
60
61
62
63Nonlocal installation
64=====================
65
66As mentioned in INSTALL one can configure the adolc package to be installed
67in a different directory than "${HOME}/adolc_base" by using the "--prefix=PATH"
68configure option. This is typically used for global installations. Common PATHs
69are "/usr" and "/usr/local/", and others are known to be used. Fine control
70over the installation directories can be gained by supplying additional
71configure options. See "./configure --help" for details.
72
73Completing the installation by executing "make install" requires write
74permissions for all target directories. Make sure to have them or the result
75may be surprising otherwise.
76
77A global installation can be helpfull if many users need the library. By adding
78the library's path to "/etc/ld.so.conf" the usage of LD_LIBRARY_PATH and the
79"-L" link switch becomes unnecessary. In many cases, for instance for
80PATH=/usr/local, the use of the -I directive for compiling sources becomes
81unnecessary too.
82
83
84
85Examples
86========
87
88Examples must be configured to build by using the configure switches
89   --enable-docexa or --enable-addexa.
90They will never be installed by make install but can be found in the
91appropriate example subdirectory.
92
93
94Windows Compilation with MINGW
95==============================
96
97Please refer to INSTALL
98
99Windows Compilation with Visual Studio
100======================================
101
102Please refer to the file windows/Readme_VC++.txt for building the library and
103ADOL-C/examples/Readme_VC++.txt for the documented examples.
104
105
106
107Unit tests
108==========
109
110ADOL-C provides more than 400 unit tests to verify its basic functionality.
111For more information how to run the tests, please check the README file in ADOL-C/boost-test directory.
112
113Enjoy this new version!
114
Note: See TracBrowser for help on using the repository browser.