source: trunk/omh/install/download.omh @ 3803

Last change on this file since 3803 was 3803, checked in by bradbell, 4 years ago

merge to branch: trunk
from repository: https://github.com/coin-or/CppAD
start hash code: d75b0cba62a41b958b974a326168299773bc4614
end hash code: 8dd8b10d36b325a3f4bbf3c03f1ea00e288331ae

commit 8dd8b10d36b325a3f4bbf3c03f1ea00e288331ae
Author: Brad Bell <bradbell@…>
Date: Fri Mar 18 20:25:17 2016 -0700

  1. replace multiple */test_one.sh.in by one bin/test_one.sh.
  2. remove test_one.sh.in from auto-tools build.

commit e524af11d04938103d42963e393b3637616dc278
Author: Brad Bell <bradbell@…>
Date: Fri Mar 18 10:02:38 2016 -0700

Move solve.cpp -> ipopt_solve.cpp so has same name as its directory.

commit 4714099e4eef9226536760e206f988440eec2f48
Author: Brad Bell <bradbell@…>
Date: Fri Mar 18 09:50:37 2016 -0700

Use system include option to supress all warnings in eigen and fadbad source.

  • Property svn:keywords set to Id
File size: 8.0 KB
Line 
1$Id: download.omh 3803 2016-03-19 05:07:48Z bradbell $
2/* --------------------------------------------------------------------------
3CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-16 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        vcdir
17        vcvarsall
18        Microsoft
19        yyyy
20        mkdir
21        cmake
22        nmake
23        Makefiles
24        omhelp
25        svn
26        https
27        org
28        dir
29        exe
30        gpl
31        xzf
32        CppAD
33        cppad
34        gzip
35        yyyymmdd
36        rel
37        lic
38        epl
39        tgz
40        hpp
41        github
42        git git
43        htm
44$$
45$dollar @$$
46
47$section Download The CppAD Source Code$$
48
49$head Purpose$$
50CppAD is an include file library and you therefore need the source
51code to use it.
52This section discusses how to download the different versions of CppAD.
53
54$head Distribution Directory$$
55We refer to the CppAD source directory created by the download instruction
56below as the distribution directory.
57To be specific, the distribution directory contains the file
58$code cppad/cppad.hpp$$.
59
60$head Compressed Archives$$
61These files have been archived using $code tar$$ and compressed using
62$code gzip$$.
63We use $icode version$$ to denote the year, month, and day,
64corresponding to a version of the CppAD API.
65For example $code 20160101$$ corresponds to January 1, 2016.
66We use $icode rel$$ to denote the release number.
67Higher release numbers corresponding to more bug fixes.
68We use $icode lic$$ to denote the licence corresponding to a compressed
69archive which can be either $code epl$$ or $code gpl$$
70($code gpl$$ denotes the GNU General Public License and
71$code epl$$ denotes the Eclipse Public License).
72The compressed archives names have one of the following formats:
73$codei%
74        cppad-%version%.%rel%.%lic%.tgz
75        cppad-%version%.%rel%.tgz
76        cppad-%version%.%lic%.tgz
77%$$
78In Unix, you can extract these compressed archives using $code tar$$.
79For example,
80$codei%
81        tar -xzf cppad-%version%.%rel%.%lic%.tgz
82%$$
83No matter what the format of the name, the corresponding distribution
84directory is $codei%cppad-%version%$$.
85To see that the extraction has been done correctly,
86check for the following file:
87$codei%
88        cppad-%version%/cppad/cppad.hpp
89%$$
90
91
92$head Current Version$$
93
94$subhead Compressed Archives$$
95$table
96$bold version$$ $pre  $$ $cnext $bold license$$ $pre  $$ $cnext $bold link$$
97$rnext
98current  $cnext EPL $cnext $href%
99http://www.coin-or.org/download/source/CppAD/cppad-20160318.epl.tgz%
100cppad-20160318.epl.tgz%$$
101$rnext
102current  $cnext GPL $cnext $href%
103http://www.coin-or.org/download/source/CppAD/cppad-20160318.gpl.tgz%
104cppad-20160318.gpl.tgz%$$
105$tend
106
107$subhead Subversion$$
108The archives above correspond to the current subversion
109$href%https://projects.coin-or.org/CppAD/browser/trunk%trunk%$$.
110You can obtain a subversion copy of the current version using the command
111$codei%
112        svn checkout https://projects.coin-or.org/svn/CppAD/trunk cppad.svn/trunk
113%$$
114This procedure requires that
115the $href%http://subversion.tigris.org/%subversion%$$ program
116is installed on your system.
117
118$subhead Git$$
119The archives above correspond to the current git
120$href%https://github.com/bradbell/cppad%master%$$.
121You can a git clone of the current version using the command
122$codei%
123    git clone https://github.com/coin-or/CppAD.git cppad.git
124%$$
125This procedure requires that
126the $href|https://en.wikipedia.org/wiki/Git_%28software%29|git|$$
127is installed on your system.
128
129
130$head Release Versions$$
131
132$subhead Coin$$
133Release versions have the $icode rel$$ field in the compressed archive name.
134The release version on the
135$href%http://www.coin-or.org/download/source/CppAD/%Coin download page%$$
136have the format
137$codei%
138        cppad-%version%.%rel%.%lic%.tgz
139%$$
140
141$subhead github$$
142The release versions on the
143$href%https://github.com/coin-or/CppAD/releases%github download page%$$
144have the format
145$codei%
146        cppad-%version%.%rel%.tgz
147%$$
148
149$head Monthly Versions$$
150Monthly versions of the compressed tar files are available on the
151$href%http://www.coin-or.org/download/source/CppAD/%Coin download page%$$.
152These are kept until the end of the current year,
153when the next release is created.
154The monthly versions have the form
155$codei%
156        cppad-%yyyy%0101.%lic%.tgz
157%$$
158where the license code $icode lic$$
159is $code gpl$$ or $code epl$$
160and $icode yyyy$$ is the current year.
161
162$head Daily Versions$$
163You can use the git version of the repository to obtain the version
164corresponding to a specific day as follows:
165$codei%
166        git clone https://github.com/coin-or/CppAD.git cppad.git
167        cd cppad.git
168        git checkout --quiet %hash_id%
169%$$
170where $icode hash_id$$ is the SHA-1 hash code for the version
171of the repository for the day of interest.
172Note that a list of these $icode hash_id$$ values can be found at the
173CppAD github
174$href%https://github.com/coin-or/CppAD/commits/master%commits/master%$$.
175page.
176
177$head Windows File Extraction and Testing$$
178If you know how to extract the distribution directory from
179the tar file, just do so. Otherwise, below is one way you can do it.
180(Note that if $code 7z.exe$$, $code cmake.exe$$, and $code nmake.exe$$ are you
181your execution path, you will not need to specify their paths below.)
182
183$list number$$
184Download and install the open source program
185$href%http://www.7-zip.org%$$.
186$lnext
187Download and install the Visual Studio Express; for example
188$href%http://www.microsoft.com/en-us/download/confirmation.aspx?id=44914
189        %Visual Studio 2013
190%$$
191$lnext
192In a command window, execute the following commands:
193$codei|
194        set PATH=|path_to_7_zip|;%PATH%
195        set PATH=|path_to_cmake|;%PATH%
196        set VCDIR=|path_to_vcdir|;%PATH%
197        call "%VCDIR%\vcvarsall.bat" x86
198|$$
199For example, on one machine these paths had the following values:
200$codei|
201        |path_to_7_zip|=C:\Program Files\7-zip
202        |path_to_cmake|=C:\Program Files (x86)\CMake\bin
203        |path_to_vcdir|=C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC
204|$$
205$lnext
206Use the following commands to extract the distribution from the
207compressed archive:
208$codei%
209        7z x cppad-%version%.%lic%.tgz
210        7z x cppad-%version%.%lic%.tar
211%$$
212$lnext
213To see if this has been done correctly, check for the following file:
214$codei%
215        cppad-%version%\cppad\cppad.hpp
216%$$
217$lnext
218The commands below are optional.
219They run the CppAD tests using the default $cref cmake$$ settings
220(except for the $cref/generator/cmake/generator/$$ option)
221$codei%
222        mkdir build
223        cd build
224        cmake -G "NMake Makefiles" ..
225        nmake check
226%$$
227$lend
228
229
230$head Install Instructions$$
231The $cref install$$ instructions on this web site correspond to the
232$cref/current version/download/Current Version/$$ of CppAD.
233If you are using an old version of CppAD
234these instructions may work.
235If you have trouble (or just to be careful),
236you should follow the instructions in
237the $code doc$$ subdirectory of the distribution directory.
238If there is no such documentation, you can build it; see
239$cref/building documentation
240        /download
241        /No Documentation
242        /Building Documentation
243/$$.
244
245$head No Documentation$$
246Some of the download methods do not include documentation.
247To be specific, the
248$cref/subversion/download/Current Version/Subversion/$$ method,
249$cref/git/download/Current Version/Git/$$ method,
250$cref/daily version/download/Daily Versions/$$ method, and the
251$cref/github release version/download/Release Versions/github/$$ method.
252In addition, these methods only provide the
253$href%http://opensource.org/licenses/EPL-1.0%EPL licensed%$$
254version of CppAD.
255
256$subhead Building Documentation$$
257If you are using one of these download methods,
258you can build the documentation to get the corresponding install instructions.
259The documentation for CppAD is built from the source code files using
260$href%http://www.seanet.com/~bradbell/omhelp/%OMhelp%$$.
261You will need to install the $code omhelp$$ command so that
262$codep
263        which omhelp
264$$
265shows it is in your path.
266Once you have done this,
267in the distribution directory execute the following command:
268$codei%
269        bin/run_omhelp.sh htm
270%$$
271You will then be able to follow the install instructions in
272the $code doc$$ subdirectory of the distribution directory.
273
274
275$end
Note: See TracBrowser for help on using the repository browser.