source: stable/20130000/omh/install/download.omh @ 2757

Last change on this file since 2757 was 2757, checked in by bradbell, 7 years ago
  1. Relevant part of bug fix to limits.cpp in trunk

between revision 2755 and 2756.

  1. Advance release number from 1 to 2.
  • Property svn:keywords set to Id
File size: 6.5 KB
Line 
1$Id: download.omh 2757 2013-02-27 20:10:22Z 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
13$begin download$$
14$escape $$
15$spell
16        mkdir
17        cmake
18        nmake
19        Makefiles
20        omhelp
21        svn
22        https
23        org
24        dir
25        exe
26        gpl
27        xvzf
28        CppAD
29        cppad
30        gzip
31        yyyymmdd
32        rel
33        lic
34        epl
35        tgz
36        hpp
37$$
38$dollar @$$
39
40$section Download The CppAD Source Code$$
41$index download, cppad$$
42$index cppad, download$$
43
44$head Purpose$$
45CppAD is an include file library and you therefore need the source
46code to use it.
47This section discusses how to download the different versions of CppAD.
48
49$head Distribution Directory$$
50We refer to the CppAD source directory created by the download instruction
51below as the distribution directory.
52To be specific, the distribution directory contains the file
53$code cppad/cppad.hpp$$.
54
55$head Compressed Tar File$$
56These files have been archived with $code tar$$
57and compressed with $code gzip$$:
58
59$subhead Current Version$$
60The download files below are for the current version of CppAD.
61
62$table
63EPL License $pre  $$ $cnext $href%
64http://www.coin-or.org/download/source/CppAD/cppad-20130000.2.epl.tgz%
65cppad-20130000.2.epl.tgz%$$
66$rnext
67GPL License $pre  $$ $cnext $href%
68http://www.coin-or.org/download/source/CppAD/cppad-20130000.2.gpl.tgz%
69cppad-20130000.2.gpl.tgz%$$
70$tend
71
72$subhead Release Versions$$
73Release versions of the compressed tar files can be found at the
74$href%http://www.coin-or.org/download/source/CppAD/%CppAD download page/%$$.
75These file have the form
76$codei%
77        cppad-%yyyymmdd%.%rel%.%lic%.tgz
78%$$
79where the license code $icode lic$$
80is $code gpl$$, $code epl$$ or $code cpl$$
81($code cpl$$ stands for the Common Public License),
82$icode yyyymmdd$$ is the date at which the features
83of the program were frozen, and each $icode rel$$ number
84corresponds to a bug fix (higher numbers corresponding to more bug fixes).
85
86$subhead Unix File Extraction$$
87On unix, you can use the command
88$codei%
89        tar -xvzf cppad-%version%.%lic%.tgz
90%$$
91where $icode version$$ either refers to the current version,
92or one of the release versions.
93This will decompress and extract the CppAD into
94the distribution directory $codei%cppad-%version%$$.
95To see if this has been done correctly, check for the following file:
96$codei%
97        cppad-%version%/cppad/cppad.hpp
98%$$
99
100$subhead Windows File Extraction$$
101If you know how to extract the distribution directory from
102the tar file, just do so. Otherwise, below is one way you can do it.
103(Note that if $code 7z.exe$$, $code cmake.exe$$, and $code nmake.exe$$ are you
104your execution path, you will not need to specify their paths below.)
105
106$list number$$
107Download and install the open source program
108$href%http://www.7-zip.org%$$.
109$lnext
110In a command window, use the command
111$codei%
112        %path_to_7-zip%\7z x cppad-%version%.%lic%.tgz
113%$$
114where $icode path_to_7-zip$$ is the location where
115$code 7z.exe$$ was installed.
116$lnext
117Then execute the command
118$codei%
119        %path_to_7-zip%\7z x cppad-%version%.%lic%.tar
120%$$
121$lnext
122To see if this has been done correctly, check for the following file:
123$codei%
124        cppad-%version%\cppad\cppad.hpp
125%$$
126In addition, you can try the following commands:
127$codei%
128        mkdir work
129        cd work
130        %path_to_cmake%\cmake -G "NMake Makefiles" ..
131        %path_to_nmake%\nmake check
132%$$
133$lend
134
135
136$subhead Install Instructions$$
137If you are using an old version of CppAD
138You should follow the install instructions in
139the $code doc$$ subdirectory of the distribution directory.
140
141
142$head Subversion$$
143
144$subhead Limitations$$
145This download procedure has the following limitations:
146$list number$$
147The $href%http://subversion.tigris.org/%subversion%$$
148program must be installed on your system.
149$lnext
150No documentation is included by this download procedure,
151though it can be build from the source code; see
152$cref/install instructions/download/Subversion/Install Instructions/$$ below.
153$lnext
154Only the
155$href%http://opensource.org/licenses/EPL-1.0%EPL licensed%$$
156version of CppAD can be obtained by this download procedure.
157$lend
158
159$subhead Current Version$$
160To obtain current version of CppAD, execute the following commands
161$codei%
162        svn export https://projects.coin-or.org/svn/CppAD/trunk %dir%
163%$$
164To see if this has been done correctly, check for the following file:
165$codei%
166        %dir%/cppad/cppad.hpp
167%$$
168We refer to your directory choice $icode dir$$ above
169as the distribution directory.
170
171$subhead Stable Versions$$
172Subversion downloads are available for a set of stable versions
173(after the specified date, only bug fixes get applied).
174The following link will list the available $icode dir$$ values
175corresponding to
176$href%https://projects.coin-or.org/CppAD/browser/stable% stable versions%$$.
177The following command will download a
178stable version of the CppAD source code:
179$codei%
180        svn export https://projects.coin-or.org/svn/CppAD/stable/%dir% %dir%
181%$$
182To see if this has been done correctly, check for the following file:
183$codei%
184        %dir%/cppad/cppad.hpp
185%$$
186Note that it will correspond to the most recent release for this stable
187version.
188
189$subhead Release Versions$$
190Subversion downloads are available for a set of release versions
191(no changes are applied).
192The following link will list the available $icode dir$$ values
193corresponding to
194$href%https://projects.coin-or.org/CppAD/browser/releases%
195        release versions
196%$$.
197The following command will download a
198release version of the CppAD source code:
199$codei%
200        svn export https://projects.coin-or.org/svn/CppAD/releases/%dir% %dir%
201%$$
202To see if this has been done correctly, check for the following file:
203$codei%
204        %dir%/cppad/cppad.hpp
205%$$
206
207$subhead Install Instructions$$
208If you are using subversion to download an old version of CppAD,
209you will have to build the documentation to get the corresponding install
210instructions.
211The documentation for CppAD is built from the source code files using
212$href%http://www.seanet.com/~bradbell/omhelp/%OMhelp%$$.
213You will need to install the $code omhelp$$ command so that
214$codep
215        which omhelp
216$$
217shows it is in your path.
218Once you have done this,
219in the distribution directory execute the following command:
220$codei%
221        ./build.sh configure omhelp
222%$$.
223You will then be able to follow the install instructions in
224the $code doc$$ subdirectory of the distribution directory.
225
226
227$end
Note: See TracBrowser for help on using the repository browser.