Revision 1149 trunk/INSTALL.txt

INSTALL.txt (revision 1149)
1
ADMB installation procedures for source and binary distributions.
2

  
3
Requirements
1
ADMB Project  
4 2
============
5
ADMB has been tested and used on Windows and Linux operating systems in both 32
6
and 64 bit versions. A C/C++ compiler must be be installed on the local computer.
3
*ADMB-11.1*  
4
*Released May 10, 2013*  
7 5

  
8
Below is a list of supported compilers:
9
 * GNU gcc version 4.7
10
 * Microsoft Visual C++ 2012
11
 * Microsoft Visual C++ 2010
12
   - Read installation help 'http://www.admb-project.org/documentation/installation/admb-installation-visual-c'.
13
 * MacOS XCode(with the Command Line Tools) version 4.6
14
 * Clang version 3.0
15
 * Intel C++ Compiler 11
16
 * Solaris Studio 12
6
Installation procedures for Unix and Windows computers.
17 7

  
18
If the compiler is not listed, try building from the source distribution. For help,
19
email 'users@admb-project.org'.
8
---
20 9

  
21
Downloads
22
=========
23
Source and pre-built binary distributions can be downloaded from
24
'http://www.admb-project.org/downloads/'.
10
Installation procedures
11
-----------------------
25 12

  
26
Quick Start
27
===========
28
* MinGW and Cygwin shells should use Unix installation procedure.
29
* Visual C++ users should use 'Windows and Visual C++' procedure.
13
For Windows computers, read the [QuickStartWindows](QuickStartWindows.html).  
30 14

  
31
Windows
32
-------
15
For Unix (Linux, MacOS, Solaris and BSD) computers, read the [QuickStartUnix](QuickStartUnix.html).
33 16

  
34
1. Download ADMB source distribution from
17
For MinGW and Cygwin shells, read the [QuickStartUnix](QuickStartUnix.html).
35 18

  
36
   'http://www.admb-project.org/downloads/'.
19
---
20
For help and support, email <users@admb-project.org>.
37 21

  
38
   Right click the downloaded file and extract to 'C:\admb\'.
39

  
40
2. Open 'Command Prompt' window and change to admb directory.
41

  
42
   C:\> cd admb
43

  
44
3. Install MinGW C++ compiler.
45

  
46
   If MinGW has been already installed, use the command below to add MinGW 
47
   programs to the system PATH.
48

  
49
   C:\> set PATH=C:\MinGW\bin;%PATH%
50

  
51
   If MinGW has not been installed, use the command below to download and 
52
   install 32-bit C++ compiler.
53

  
54
   C:\admb\> utilities\get-mingw.bat
55

  
56
   Downloads approximately 177 MB from 'sourceforge.net'.  This will also 
57
   update existing MinGW installation.
58

  
59
4. Build libraries
60

  
61
   C:\admb\> utilities\make
62

  
63
   To build with debug symbols,
64

  
65
   C:\admb\> utilities\make debug
66

  
67
   Takes approximately 15-25 minutes to complete.
68

  
69
5. Build and run the simple example.
70

  
71
   C:\admb\> cd examples\admb\simple
72
   C:\admb\examples\admb\simple\> C:\admb\admb simple
73
   C:\admb\examples\admb\simple\> simple
74

  
75
6. [Optional] Include admb in system 'PATH'.
76
   Avoids the need the to add the prefix path to the admb script. 
77

  
78
   A. In the 'System Properties' window, click on the 'Enviroment Variables' button.
79

  
80
   B. In the 'Enviroment Variables' windows, click on the 'New...' button, 
81
   in the 'Variable name:' type 
82

  
83
   PATH
84

  
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff