source: trunk/omh/install/adolc_prefix.omh @ 2941

Last change on this file since 2941 was 2941, checked in by bradbell, 7 years ago

General comments about this commit go here (delete this line).

check_define.sh: ignore files that are output during configuration.
whats_new_13.omh: fix spelling.
makefile.in: fix modification date.
adolc_prefix.omh: require that Colpack and Adolc have same prefix.

  • Property svn:keywords set to Id
File size: 4.1 KB
Line 
1/* $Id: adolc_prefix.omh 2941 2013-10-15 02:26:20Z bradbell $ */
2/* --------------------------------------------------------------------------
3CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-13 Bradley M. Bell
4
5CppAD is distributed under multiple licenses. This distribution is under
6the terms of the
7                    Eclipse Public License Version 1.0.
8
9A copy of this license is included in the COPYING file of this distribution.
10Please visit http://www.coin-or.org/CppAD/ for information on other licenses.
11-------------------------------------------------------------------------- */
12$begin adolc_prefix$$
13$dollar @$$
14$spell
15        dir
16        mul
17        cmake
18        includedirs
19        CppAD
20        adolc
21        adouble
22        colpack
23        cygdrive
24        Cygwin
25        bashrc
26$$
27
28$section Including the ADOL-C Examples and Tests$$
29$index adolc, example$$
30$index example, adolc$$
31$index test, adolc$$
32
33$head Purpose$$
34CppAD includes examples and tests that can use the AD package
35$href%https://projects.coin-or.org/ADOL-C%ADOL-C%$$.
36The includes speed comparison with other AD packages; see
37$cref speed_adolc$$.
38It also includes examples that combine ADOL-C with
39CppAD; see
40$table
41$rref base_adolc.hpp$$
42$rref mul_level_adolc.cpp$$
43$rref mul_level_adolc_ode.cpp$$
44$tend
45
46$head adolc_prefix$$
47$index adolc, prefix$$
48$index prefix, adolc$$
49If ADOL-C is installed on your system, you can
50specify a value for its install $icode adolc_prefix$$ on the
51$cref cmake$$ command line.
52The value of $icode adolc_prefix$$ must be such that,
53for one of the directories $icode dir$$ in
54$cref/cmake_install_includedirs/cmake/cmake_install_includedirs/$$,
55$codei%
56        %adolc_prefix%/%dir%/adolc/adouble.h
57%$$
58is a valid way to reference to the include file $code adouble.h$$;
59Note that CppAD assumes ADOL-C has been configured with
60its sparse matrix computations enabled; i.e, using
61$codei%
62        --with-colpack=%adolck_prefix%
63%$$
64In other words ColPack
65has been installed with the same prefix as ACOL-C; see
66$cref get_colpack.sh$$.
67
68$head Examples$$
69$index adolc, examples$$
70$index examples, adolc$$
71If you include $icode adolc_prefix$$ on the $cref cmake$$ command line,
72you will be able to run the ADOL-C examples listed above
73by executing the following commands starting in the
74$cref/distribution directory/download/Distribution Directory/$$:
75$codei%
76        cd build/example
77        make check_example
78%$$
79If you do this,
80you will see an indication that the examples
81$code mul_level_adolc$$ and $code mul_level_adolc_ode$$
82have passed their correctness check.
83
84$head Speed Tests$$
85$index adolc, speed$$
86$index speed, adolc$$
87If you include $icode adolc_prefix$$ on the $cref cmake$$ command line,
88you will be able to run the ADOL-C speed correctness tests
89by executing the following commands starting in the
90$cref/distribution directory/download/Distribution Directory/$$:
91$codei%
92        cd build/speed/adolc
93        make check_speed_adolc
94%$$
95After executing $code make check_speed_adolc$$,
96you can run a specific ADOL-C speed tests
97by executing the command $code ./speed_adolc$$;
98see $cref speed_main$$ for the meaning of the command line
99options to this program.
100
101$head Unix$$
102$index adolc, unix$$
103$index unix, adolc$$
104If you are using Unix,
105you may have to add
106$icode adolc_prefix$$ to $code LD_LIBRARY_PATH$$.
107For example, if you use the $code bash$$ shell to run your programs,
108you could include
109$codei%
110        LD_LIBRARY_PATH=%adolc_prefix%/lib:@{LD_LIBRARY_PATH}
111        export LD_LIBRARY_PATH
112%$$
113in your $code @HOME/.bashrc$$ file.
114
115$head Cygwin$$
116$index adolc, cygwin$$
117$index cygwin, adolc$$
118If you are using Cygwin,
119you may have to add to following lines to the file
120$code .bashrc$$ in your home directory:
121$codei%
122        PATH=%adolc_prefix%/bin:@{PATH}
123        export PATH
124%$$
125in order for ADOL-C to run properly.
126If $icode adolc_prefix$$ begins with a disk specification,
127you must use the Cygwin format for the disk specification.
128For example,
129if $code d:/adolc_base$$ is the proper directory,
130$code /cygdrive/d/adolc_base$$ should be used for $icode adolc_prefix$$.
131
132$children%
133        bin/get_adolc.sh
134%$$
135$head get_adolc$$
136$index get, adolc$$
137$index adolc, get$$
138If you are using Unix, you can download and install
139a copy of Adolc using $cref get_adolc.sh$$.
140The corresponding $icode adolc_prefix$$ would be
141$code build/prefix$$.
142
143$end
Note: See TracBrowser for help on using the repository browser.