The instructions below describes the process for building and installing VAPOR on UNIX and Mac platforms.
|
Note: it is strongly recommended that the binary installation be used if at all possible. Building from source can be difficult and time consuming. |
Note to Mac users: the instructions below will not generate a Mac Application (.app file): the resulting vaporgui executable must be invoked from the command line.
After resolving any of VAPOR library dependencies, you are ready to begin the build process. If you haven't done so already, download the source tar file. After downloading, uncompress and unpack the tar file, and then change working directories to the VAPOR source directory by using the following commands or their equivalents:
gunzip vapor-x.x.x-src.tar.gz
tar xf vapor-x.x.x-src.tar
cd vapor-x.x.x-src
where 'x.x.x' is the VAPOR version number.
The first step in the compilation process is to edit the top-level options.mk file. This file contains gmake Makefile macros that are used to inform the build system of the locations of various 3rd party packages, and also allows you to configure various optional components. In particular, the macros with "PATH" suffixes will in most cases need to be defined to point to the locations of various library and header file paths. Other macros of interest are the INSTALL_PREFIX and macros with the "IDL" prefix, which tell the build system where to install VAPOR, and control whether IDL support routines are generated, respectively. The most up-to-date, and complete descriptions of these and other variables are found as comments in the options.mk file itself.
Once the VAPOR installation system has been configured, you may compile by simply typing:
gmake
or possibly just
make
if your version of make is gmake compilant. The build process takes anywhere from a few minutes to a half an hour. After compiling the software, executable and libraries may be installed by executing
gmake install
Executables, libraries, and header files will be installed to the installation target directory defined previously in the configuration step.
The VAPOR suite of applications relies on a number of shared libraries. Users will be required to execute a configuration script prior to running any VAPOR commands. The script vapor_home/bin/vapor-setup.sh should be sourced by all users before starting a VAPOR session, where vapor_home is the value of the INSTALL_PREFIX_DIR macro found in the options.mk file used to configure vapor. For convenience it is advised that users place this command in their login script (.login for C shell or .profile for other shells). Once the variables are set in the login script, there is no need to run the environment script files for each session.
|
C-shell derivative users (csh, tcsh) If you are a C-shell (csh, tcsh) user you must execute the following command prior to running any VAPOR utilities: source vapor_home/bin/vapor-setup.csh
where vapor_home is the root of the installation directory for VAPOR. Bourne shell derivative users (ksh, bash, sh) If you are a Bourne shell (sh, bash, ksh) user you must execute the following command prior to running any VAPOR utilities: . vapor_home/bin/vapor-setup.sh
where vapor_home is the root of the installation directory for VAPOR. Note the "." is the bourne shell command for sourcing a file. |
