build_roms.py

#!/usr/bin/env python2
# encoding: utf-8
"""
build_roms.py

Created by Rob Hetland on 2008-03-31.
Copyright (c) 2008-2022 Rob Hetland. All rights reserved.

Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.
"""

import sys
import os
import getopt

help_message = '''
build-roms.py is a script used to build the Regional Ocean Modeling System

Usage:

    build-roms.py [options] ROMS_APPLICATION

The ROMS_APPLICATION, the sole argument to the script, must be either specified
on the command line, or present as an environmental variable.  If present, the
argument will override the environmental variable.

Options:

    -h, --help        Print this message

    --fort=[ifort]    Specify fortran compiler
    --netcdf=[4, 3]   Version of NetCDF to use [default is NetCDF4]
    -j=n              Parallel make [n = number of procs, default is 4]

    --mpi             Compile using mpi
    --clean           Delete Build scratch directory before build
    --debug           Compile in debug mode
    --root            Specify ROMS_ROOT_DIR

Default values can be taken from environmental variables, if present.  Command
line options always override defaults.  Environmental variables are:

    FORT            for fortran compiler, overriden by --fort
    ROMS_ROOT_DIR   for ROMS root directory, overriden by --root
'''

class Usage(Exception):
    def __init__(self, msg):
        self.msg = msg


def main(argv=None):
    if argv is None:
        argv = sys.argv
    try:
        try:
            opts, args = getopt.getopt(argv[1:], "hj", \
                         ["help", "mpi", "fort=", "netcdf=", "debug", "clean", "root"])
        except getopt.error, msg:
            raise Usage(msg)
    
        # Get default values from environment, if present
    
        if os.environ.has_key('ROMS_ROOT_DIR'):
            ROMS_ROOT_DIR = os.environ['ROMS_ROOT_DIR']
        else:
            ROMS_ROOT_DIR=os.path.join(os.environ['HOME'], 'COAWST')
            
        USE_MPI=''
        USE_MPIF90=''
    
        USE_DEBUG=''
        USE_LARGE='on'
    
        if os.environ.has_key('FORT'):
            FORT = os.environ['FORT']
        else:
            FORT='gfortran'
    
    
        USE_NETCDF4='on'
    
        NP=32
    
        # option processing
        for option, value in opts:
            if option in ("-h", "--help"):
                raise Usage(help_message)
            if option == "--mpi":
                USE_MPI = 'on'
                USE_MPIF90 = 'on'
            if option == "--fort":
                FORT=value
            if option == "--netcdf":
                if value != '4':
                    USE_NETCDF4=''
            if option == "--root":
                ROMS_ROOT_DIR=value
            if option == "--debug":
                USE_DEBUG = 'on'
            if option == "-j":
                NP = value
            if option == "--clean":
                print 'Removing Build directory...'
                os.system('rm -rf Build')
    
        if os.environ.has_key('ROMS_APPLICATION'):
            ROMS_APPLICATION = os.environ['ROMS_APPLICATION'].upper()
        else:
            assert len(args) == 1, 'ERROR: Must specify ROMS_APPLICATION'
    
        if len(args) == 1:
            ROMS_APPLICATION=args[0].upper()
    
        headerfile = ROMS_APPLICATION.lower() + '.h'
        assert os.path.exists(headerfile), \
            'ERROR: header file %s does not exist' % headerfile

    except Usage, err:
        print >> sys.stderr, sys.argv[0].split("/")[-1] + ": " + str(err.msg)
        return 2

    MY_PROJECT_DIR=os.getcwd()
    MY_HEADER_DIR=MY_PROJECT_DIR
    MY_ANALYTICAL_DIR=os.path.join(MY_PROJECT_DIR,'Functionals')
    BINDIR=MY_PROJECT_DIR
    SCRATCH_DIR=os.path.join(MY_PROJECT_DIR,'Build')

    ENV_STR = 'ROMS_APPLICATION=%s FORT=%s USE_MPI=%s USE_MPIF90=%s USE_NETCDF4=%s USE_DEBUG=%s USE_LARGE=%s MY_HEADER_DIR=%s MY_ANALYTICAL_DIR=%s BINDIR=%s SCRATCH_DIR=%s' % (ROMS_APPLICATION, FORT, USE_MPI, USE_MPIF90, USE_NETCDF4, USE_DEBUG, USE_LARGE, MY_HEADER_DIR, MY_ANALYTICAL_DIR, BINDIR, SCRATCH_DIR)

    print ENV_STR.replace(' ', '\n')

    os.system("cd %s ; %s make -j %s" % (ROMS_ROOT_DIR, ENV_STR, NP))


if __name__ == "__main__":
    sys.exit(main())