A primitive-equation ocean model upgraded by the
NCAR Oceanography Section National Center for Atmospheric Research1 PO Box 3000, Boulder, CO 80307
R.C. Pacanowski K. Dixon A. Rosati Geophysical Fluid Dynamics Laboratory /NOAA Princeton, NJ. 08542
Substantial changes to MOM 1.1 have been made in the
NCOM, and present MOM 1.1 users should be alert to such
changes and familiarize themselves with the many differences.
The user should pay particular attention
to the added model features and to the list of preprocessor
options: many of the MOM 1.1 options have been removed (see
checks.F), and several new options have been added.
Users interested in the major changes to the last major
release of our model, NCOM 1.3, which
resulted in NCOM 1.4.0 should refer to our web
document
What's New in NCOM 1.4 .
Documentation of the June 1997 NCOM release is available in
the NCAR technical
note referenced below. Hard-copies of the technical note were
distributed at the May 1996 and June 1997 CSM Workshops;
electronic copies are also available.
NCOM 1.4.0 documentation is available only from the NCOM website.
The NCOM user is encouraged to periodically check our website
for code updates and announcements. New and updated links may
become available after the official NCOM 1.4 release date of
July 17, 1998.
The NCOM presently executes mainly on the NCAR Cray J-90 and
C-90 computers. The code should also execute on other architectures
with few, if any, modifications, but NCOM performance on some of these
other platforms may be poorer than on the Crays. NCOM 1.4.0 code contains
preliminary modifications for HP, SGI, and SX4 architectures.
This version of the NCOM is configured to execute with four
possible resolutions: the 152x111x45 (2x2) and 102x74x25 (3x3),
documented in the NCOM Technical Note webpage, and two
new resolutions, 152x173x45 ( "x2' ")
and 102x116x25 ("x3 '") .
The user selects the desired resolution by setting the environment
variable OCNRES in the coupled or stand-alone job scripts
(ocn.setup.csh and stand-alone.csh, respectively.)
The present release of the NCAR CSM models relies on a locally modified
version of MPI.
The NCOM distribution (ncom1.4.0.tar.gz) consists of the NCOM 1.4
Fortran source code and a collection of shell scripts. (See the
ascii file with a diagram of the ncom1.4.0
structure.)
Users may notice the absence of the netCDF_Filters directory in NCOM
Release 1.4.0. These filter files are obsolete, because netcdf history
files can now be produced directly in the model at run-time.
ocn.setup.csh is the script that the Flux-Coupler driver code will
invoke in order to create an executable image and generate and/or
collect all necessary start-up files. It can be used with any of the
four supported ocean-model resolutions.
ocn.setup.csh, is described in general
terms in the Flux-Coupler documentation, and should be copied
to the directory specified by the environment variable $NQSDIR.
(Set NQSDIR in the Flux-Coupler driver script -- the "*.nqs" script)
NOTE: The script ocn.setup.csh must be edited before
it is used for the first time. The user must define the
script variable MainDir, which identifies the parent
directory of the source-code directory; e.g.,
set MainDir = ~/ncom1.4.0
Also, the resolution must be properly set; for example:
setenv OCNRES 102x116x45
Resolution-dependent namelist files with default model-input values
reside in the Namelists subdirectory
of the resolution-dependent directories (~/ncom1.4.0/102x74x25/Namelists, eg)
setdefs.csh is executed by ocn.setup.csh ; this is
the script which creates the list of C preprocessor
options for the ocean code. setdefs.csh is presently configured
as documented in the NCOM manual, but if the user wishes to
customize her/his application, this is the script in which to
specify the various available options.
NOTE: Unlike the ocn.setup.csh script, this script may remain
in the "Scripts" subdirectory when creating the ocn binary;
by default, the ocn.setup.csh script will look for setdefs.csh
there. You may prefer, however, to
copy setdefs.csh to the same
directory as the one which contains ocn.setup.csh,
but if you do so, you must edit the setup
script to identify the new location (see
the ScriptDir definition in ocn.setup.csh)
This script is the stand-alone
counterpart to the coupled-model job script, ocn.setup.csh.
This batch-job script collects and compiles the
NCOM source code, executes the Cpp option-generating script,
collects all necessary start-up files, and executes
the stand-alone ocean model. The script
is designed to be self-documenting; please read the documentation
that accompanies each script and follow the instructions listed
there.
NOTE: The script stand-alone.csh must be edited before
it is used for the first time. The user must define the
script variable MainDir, which identifies the parent
directory of the source-code directory; e.g.,
set MainDir = ~/ncom1.4.0
Also, the resolution must be properly set; for example:
setenv OCNRES 102x116x45
The script comments indentify those variables which must be set
by the user before execution -- do not attempt to use the
scripts without first setting these values.
setdefs.csh is executed by stand_alone.csh; it is
the script which creates the list of C preprocessor
options for the ocean code. setdefs.csh is presently configured
as documented in the NCOM manual, but if the user wishes to
customize her/his application, this is the script in which to
specify the various available options. This version of
setdefs.csh is quite similar, but not identical, to the
coupled-model version.
The script list_revision_numbers_from_Cray is used to document the
RCS revision number of each file used in the compilation of the NCOM
source code. It is called from within ocn.setup.csh, and it will
produce a listing of each file and its corresponding revision number
in the file ocn_compile_output_mm_dd_yyyy_hh:mm:ss, which is
generated each time ocn.setup.csh is invoked.
The script output_file_print_statement is called from
list_revision_numbers_from_Cray and is used to format the
revision-number information.
The Fortran 90 version of the NCOM Makefile is the only one
provided and supported.
(c) Copyright 1998 University Corporation for Atmospheric Research/
National Center for Atmospheric Research/
Climate and Global Dynamics Division
This software, the NCAR CSM Ocean Model (NCOM), version 1.4 , was
upgraded by the Oceanography Section of the Climate and
Global Dynamics Division (CGD) of the National Center for Atmospheric
Research (NCAR), which is operated by the University Corporation for
Atmospheric Research (UCAR) and sponsored by the National Science
Foundation (NSF).
Access and use of this software shall impose the following obligations
and understandings on the user. The user is granted the right,
without any fee or cost, to use, copy, modify, alter, enhance and
distribute this software, and any derivative works thereof, and its
supporting documentation for any purpose whatsoever, except commercial
sales, provided that this entire notice appears in all copies of the
software, derivative works and supporting documentation. Further, the
user agrees to credit UCAR/NCAR/CGD in any publications that result
from the use of this software or in any software package that includes
this software. The names UCAR/NCAR/CGD, however, may not be used in
any advertising or publicity to endorse or promote any products or
commercial entity unless specific written permission is obtained from
UCAR/NCAR/CGD.
THE NCOM MATERIALS ARE MADE AVAILABLE WITH THE UNDERSTANDING THAT
UCAR/NCAR/CGD IS NOT OBLIGATED TO PROVIDE (AND WILL NOT PROVIDE) THE
USER WITH ANY SUPPORT, CONSULTING, TRAINING, OR ASSISTANCE OF ANY KIND
WITH REGARD TO THE USE, OPERATION AND PERFORMANCE OF THIS SOFTWARE, NOR
TO PROVIDE THE USER WITH ANY UPDATES, REVISIONS, NEW VERSIONS, OR "BUG
FIXES."
THIS SOFTWARE IS PROVIDED BY UCAR/NCAR/CGD "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL UCAR/NCAR/CGD BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER,
INCLUDING BUT NOT LIMITED TO CLAIMS ASSOCIATED WITH THE LOSS OF DATA
OR PROFITS, WHICH MAY RESULT FROM AN ACTION IN CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS CLAIM THAT ARISES OUT OF OR IN CONNECTION WITH THE
ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
1 The National Center for Atmospheric Research is sponsored by
the National Science Foundation.
NCAR CSM Ocean Model, Version 1.4
All upgrades from the GFDL MOM 1.1 code
are subject to Copyright (C) 1996, 1997, 1998
University Corporation for Atmospheric Research
All Rights Reserved
This page is maintained by Nancy Norton
( njn01@ncar.ucar.edu )
Last modified on
Table of Contents
Introduction
NCOM Documentation
Return to Table of Contents
General Notes on NCOM 1.4.0
Return to Table of Contents
Description of Tar File Contents
Return to Table of Contents
Copyright
DISTRIBUTION TERMS AND CONDITIONS NOTICE