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

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

Use build instead of work directory for building.

  • Property svn:keywords set to Id
File size: 3.7 KB
Line 
1/* $Id: adolc_prefix.omh 2740 2013-01-12 16:56:53Z 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
47$head adolc_prefix$$
48$index adolc, prefix$$
49$index prefix, adolc$$
50If ADOL-C is installed on your system, you can
51specify a value for its install $icode adolc_prefix$$ on the
52$cref cmake$$ command line.
53The value of $icode adolc_prefix$$ must be such that,
54for one of the directories $icode dir$$ in
55$cref/cmake_install_includedirs/cmake/cmake_install_includedirs/$$,
56$codei%
57        %adolc_prefix%/%dir%/adolc/adouble.h
58%$$
59is a valid way to reference to the include file $code adouble.h$$;
60Note that CppAD assumes ADOL-C has been configured with
61its sparse matrix computations enabled; i.e, using
62$codei%
63        --with-colpack=%colpack_prefix%
64%$$
65
66$head Examples$$
67$index adolc, examples$$
68$index examples, adolc$$
69If you include $icode adolc_prefix$$ on the $cref cmake$$ command line,
70you will be able to run the ADOL-C examples listed above
71by executing the following commands starting in the
72$cref/distribution directory/download/Distribution Directory/$$:
73$codei%
74        cd build/example
75        make check_example
76%$$
77If you do this,
78you will see an indication that the examples
79$code mul_level_adolc$$ and $code mul_level_adolc_ode$$
80have passed their correctness check.
81
82$head Speed Tests$$
83$index adolc, speed$$
84$index speed, adolc$$
85If you include $icode adolc_prefix$$ on the $cref cmake$$ command line,
86you will be able to run the ADOL-C speed correctness tests
87by executing the following commands starting in the
88$cref/distribution directory/download/Distribution Directory/$$:
89$codei%
90        cd build/speed/adolc
91        make check_speed_adolc
92%$$
93After executing $code make check_speed_adolc$$,
94you can run a specific ADOL-C speed tests
95by executing the command $code ./speed_adolc$$;
96see $cref speed_main$$ for the meaning of the command line
97options to this program.
98
99$head Unix$$
100$index adolc, unix$$
101$index unix, adolc$$
102If you are using Unix,
103you may have to add
104$icode adolc_prefix$$ to $code LD_LIBRARY_PATH$$.
105For example, if you use the $code bash$$ shell to run your programs,
106you could include
107$codei%
108        LD_LIBRARY_PATH=%adolc_prefix%/lib:@{LD_LIBRARY_PATH}
109        export LD_LIBRARY_PATH
110%$$
111in your $code @HOME/.bashrc$$ file.
112
113$head Cygwin$$
114$index adolc, cygwin$$
115$index cygwin, adolc$$
116If you are using Cygwin,
117you may have to add to following lines to the file
118$code .bashrc$$ in your home directory:
119$codei%
120        PATH=%adolc_prefix%/bin:@{PATH}
121        export PATH
122%$$
123in order for ADOL-C to run properly.
124If $icode adolc_prefix$$ begins with a disk specification,
125you must use the Cygwin format for the disk specification.
126For example,
127if $code d:/adolc_base$$ is the proper directory,
128$code /cygdrive/d/adolc_base$$ should be used for $icode adolc_prefix$$.
129
130$end
Note: See TracBrowser for help on using the repository browser.