| 1 | |
|---|
| 2 | ADOL-C |
|---|
| 3 | |
|---|
| 4 | This 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 | |
|---|
| 12 | and many bug fixes. |
|---|
| 13 | |
|---|
| 14 | Furthermore the source code was adapted to allow a compilation with |
|---|
| 15 | WINDOWS compilers. See file "INSTALL" for generic installation |
|---|
| 16 | instructions and special instructions for the installation on a WINDOWS |
|---|
| 17 | platform. |
|---|
| 18 | |
|---|
| 19 | The complete documentation can be found in the subdirectory "doc". |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | LOCAL INSTALLATION |
|---|
| 24 | ================== |
|---|
| 25 | |
|---|
| 26 | 1. 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 | --enable-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 | --enable-docexa build documented examples [default=no] |
|---|
| 37 | --enable-addexa build additional examples [default=no] |
|---|
| 38 | --enable-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 | |
|---|
| 44 | 2. Type make |
|---|
| 45 | |
|---|
| 46 | 3. 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 | |
|---|
| 52 | This procedure provides all makefiles required in the approporate directories. |
|---|
| 53 | Execute 'configure --help' for more details on other available option. |
|---|
| 54 | |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | Nonlocal installation |
|---|
| 58 | ===================== |
|---|
| 59 | |
|---|
| 60 | As mentioned in INSTALL one can configure the adolc package to be installed |
|---|
| 61 | in a different directory than "${HOME}/adolc_base" by using the "--prefix=PATH" |
|---|
| 62 | configure option. This is typically used for global installations. Common PATHs |
|---|
| 63 | are "/usr" and "/usr/local/", and others are known to be used. Fine control |
|---|
| 64 | over the installation directories can be gained by supplying additional |
|---|
| 65 | configure options. See "./configure --help" for details. |
|---|
| 66 | |
|---|
| 67 | Completing the installation by executing "make install" requires write |
|---|
| 68 | permissions for all target directories. Make sure to have them or the result |
|---|
| 69 | may be surprising otherwise. |
|---|
| 70 | |
|---|
| 71 | A global installation can be helpfull if many users need the library. By adding |
|---|
| 72 | the 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 |
|---|
| 74 | PATH=/usr/local, the use of the -I directive for compiling sources becomes |
|---|
| 75 | unnecessary too. |
|---|
| 76 | |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | Examples |
|---|
| 80 | ======== |
|---|
| 81 | |
|---|
| 82 | Examples must be configured to build by using the configure switches |
|---|
| 83 | --enable-docexa or --enable-addexa. |
|---|
| 84 | They will never be installed by make install but can be found in the |
|---|
| 85 | appropriate example subdirectory. |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | |
|---|
| 89 | Windows Compilation with Visual Studio |
|---|
| 90 | ====================================== |
|---|
| 91 | |
|---|
| 92 | Please refer to the file windows/Readme_VC++.txt for building the library and |
|---|
| 93 | ADOL-C/examples/Readme_VC++.txt for the documented examples. |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | Enjoy this new version! |
|---|
| 98 | |
|---|
