ADMB Project

ADMB-trunk
Released Month DD, YYYY

Describe ADMB build and installation procedures for Unix operating systems such as Linux, MacOS, Solaris and BSD.


Prerequisites

The following programs should be installed on the local computer.

Note — For MacOS, install XCode with command line tools includes all the prerequistes.

Quick Start

  1. Open a Terminal window

  2. Download ADMB

    To get the most current code, download from directly from ADMB version control using the command below.

       [~]$ svn checkout http://www.admb-project.org/svn/trunk admb
    

    This will copy admb trunk folder to ~/admb/.

    If unable to checkout, download full source distribution.

    Use the command below to extract to ~/admb/.

       [~]$ unzip admb.zip
    
  3. Change to admb directory

       [~]$ cd admb
    
  4. Build ADMB

    To build ADMB, use the commands below.

       [~/admb/]$ make
    

    If debug symbols are needed, use the commands below.

       [~/admb/]$ make debug
    

    Note — When completed, ~/admb/build/dist is the binary distribution directory.

  5. Use ADMB

    The following commands build and run the simple example.

       [~/admb/]$ cd examples/admb/simple
       [~/admb/examples/admb/simple/]$ ~/admb/admb simple.tpl
       [~/admb/examples/admb/simple/]$ ./simple
    

    For MinGW and Cygwin shells, use the 'admb.sh' script.

       [~/admb/]$ cd examples/admb/simple
       [~/admb/examples/admb/simple/]$ ~/admb/admb.sh simple.tpl
       [~/admb/examples/admb/simple/]$ ./simple
    
  6. Optional — Installation

    The dist folder can be copied to other computers with similar configurations.

    Follow the procedure below to avoid typing the directory when calling the admb script.

    Copy binary distribution folder to /usr/local/ as super-user.

       [~/admb/]$ sudo cp -Rvf build/dist  /usr/local/admb
    

    Create symlink to main admb script. Directory /usr/local/bin/ should already exist.

       [~/admb/]$ sudo ln -sf /usr/local/admb/admb /usr/local/bin/admb
    

    After copying, build and run the simple example.

       [~/admb/]$ cd examples/admb/simple
       [~/admb/examples/admb/simple/]$ admb simple.tpl
       [~/admb/examples/admb/simple/]$ ./simple
    

For help and support, contact users@admb-project.org.

$Id: QuickStartUnix.txt 2111 2014-06-17 00:05:03Z johnoel $