Skip to content

Latest commit

 

History

History
260 lines (181 loc) · 5.74 KB

NCAR_build_environment.osx.md

File metadata and controls

260 lines (181 loc) · 5.74 KB
Raw

Building using the NCAR development environment - OSX

Setting up the NCAR development environmant allows a user to develop LROSE-specific code in an efficient environment.

It uses Makefiles that are simple to use, rather than the complex makefiles generated by the GNU tools autoconf and automake.

  1. prepare
  2. download
  3. setenv
  4. build

1. Prepare the OS

Install either the XCode development environment or a stand-alone version of the XCode command line tools. If you intend to do lots of Apple development and want to use an IDE, then install XCode.

Installing complete XCode

To install the full XCode package, get an Apple ID and register for the Apple App Store.

You will need to provide a credit card, so Apple can charge you if you actually buy anything.
However, XCode is free.

From the App Store, install XCode. Start XCode, open the preferences window, select the 'Downloads' tab, and install "Command Line Tools"

You may also need to run:

  xcode-select --install

Installing stand-alone XCode command line tools

Alternatively, you can install the stand-alone XCode command line tools by downloading "Command Line Tools" from:

  http://developer.apple.com/downloads

You will need to register for a free Apple id, no credit card is required.

Install homebrew

The default location for homebrew is /usr/local. So you need write permission to /usr/local to perform the install.

Run the following ruby script:

  /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  /usr/local/bin/brew update

Install required packages, using brew

  brew install pkg-config
  brew install szip
  brew install hdf5 --enable-cxx
  brew install netcdf
  brew install udunits
  brew install fftw
  brew install flex
  brew install jasper
  brew install jpeg
  brew install libpng
  brew install qt

2. Download from GitHub

Create a working directory for cloning:

  mkdir -p ~/git
  cd ~/git

Clone the current LROSE version from GitHub

  cd ~/git
  git clone https://github.com/ncar/lrose-core

The distribution will be in the lrose-core subdirectory:

  cd ~/git/lrose-core

3. Setting up your environment

The software development system at NCAR/RAL (formerly RAP) and NCAR/EOL makes use of a recursive makefile approach, using environment variables to identify the various directories used during the build.

Therefore, before performing the build, you need to set up the correct environment, as follows:

Set the environment variable for the directory into which you wish to install the build:

  $LROSE_INSTALL_DIR

This will normally be:

  ~/lrose

The build will be installed in:

  $LROSE_INSTALL_DIR/bin
  $LROSE_INSTALL_DIR/lib
  $LROSE_INSTALL_DIR/include

Set the environment variable to point to the git lrose-core directory:

  $LROSE_CORE_DIR

This should point to the top of the distribution, i.e. lrose-core.

This will normally be:

  ~/git/lrose-core

Source the environment, depending on the shell you are using:

For sh or bash:

  cd $LROSE_CORE_DIR
  source build/set_build_env.osx.sh

For csh or tcsh:

  cd $LROSE_CORE_DIR
  source build/set_build_env.osx.csh

Preferably, you should permanently copy the contents of these these files directly into your .cshrc or .bashrc file. That way the environment will always be correcty set.

This will set the following important environment variables:

 $HOST_OS: should be OSX_LROSE
 $RAP_MAKE_INC_DIR: include files used by the makefiles
 $RAP_MAKE_BIN_DIR: scripts for the make
 $RAP_INC_DIR: the include install directory
 $RAP_LIB_DIR: the library install directory
 $RAP_BIN_DIR: the binary install directory

Several other variables are set as well.

4. Build

Install the makefiles

The make application can use makefiles named either Makefile or makefile. The lower-case version takes preference.

The codebase is checked in with upper-case Makefiles throughout the tree.

To get the build you want, you must install the lower-case makefiles relevant to the package you need.

To install the lrose standard package makefiles, perform the following:

  cd $LROSE_CORE_DIR/codebase
  ./make_bin/install_package_makefiles.py

This is equivalent to the following

  cd $LROSE_CORE_DIR/codebase
  ./make_bin/install_package_makefiles.py --package lrose

If you want to perform a specific package package, you can specify that on the command line.

For the radx distribtion, run the following:

  cd $LROSE_CORE_DIR/codebase
  ./make_bin/install_package_makefiles.py --package radx

For the titan distribtion, run the following:

  cd $LROSE_CORE_DIR/codebase
  ./make_bin/install_package_makefiles.py --package titan

Perform the build

(a) Build and install the TDRP parameter handling utility

  cd $LROSE_CORE_DIR/codebase/libs/tdrp/src
  make opt install
  cd $LROSE_CORE_DIR/codebase/apps/tdrp/src
  make opt install

(b) Build and install the libraries

  cd $LROSE_CORE_DIR/codebase/libs/
  make install_include
  make -j 8 opt
  make -j 8 install

(c) Build and instal the applications

  cd $LROSE_CORE_DIR/codebase/apps
  make -j 8 opt
  make -j 8 install

Building individual applications

Once you have set up the environment specified above, you are free to edit and build individual applications.

For example, if you want to work on RadxConvert, you would go to the relevant directory and perform the build locally there.

  cd $LROSE_CORE_DIR/codebase/apps/Radx/src/RadxConvert
  make clean
  make opt
  make install