dcpam5 Installation Guide

1. Operation Environment
2. Software Requirements
3. How to build
4. Execute a sample program

Operation Environment

This program is operated by following compilers.

• Debian GNU/Linux 4.0 + Fujitsu Fortran 5.0 (in JAPANESE)
• Debian GNU/Linux 4.0 + Intel Fortran 10.0

dcpam5 was operated by following environments in the past. Latest version may be operated (unconfirmed).

• Debian GNU/Linux 3.1 + Fujitsu Fortran 5.0 (in JAPANESE)
• Debian GNU/Linux 3.1 + Intel Fortran 9.0
• Debian GNU/Linux 3.1, 4.0 + G95 Fortran 0.9
• NEC SX-8 + FORTRAN90/SX

Software Requirements

Following softwares should be installed for installing dcpam.

netCDF (version 3.6.X or more)

Debian GNU/Linux (use binary packages)

• debian packages [Fujitsu ver5 | Intel ver10.0 | G95]

  If you use above Debian package to install netCDF, you need "netcdf-bin" package too. (Parhaps you can get by "apt-get").

Build from source codes

• Version 3.6.2 TGZ,

  [Quick Instructions for Installing (Unidata)]

  • [NetCDF Installation and Porting Guide (Unidata)]

gt4f90io (version 20080729 or more)

Debian GNU/Linux (use binary packages)

• debian packages [Fujitsu ver5 | Intel ver10.0 | G95]

Build from source codes

• Latest version TGZ

  Installation Guide

ISPACK (in JAPANESE) (version 0.71)

Debian GNU/Linux (use binary packages)

• debian packages [Fujitsu ver5 | Intel ver10.0 | G95]

Build from source codes

• Version 0.71 TGZ

  See "README" file in above tar.gz file. (but that is wrote in JAPANESE)

spmodel (version 0.4.1 or more)

Debian GNU/Linux (use binary packages)

• debian packages [Fujitsu ver5, ssl2 | Intel ver10.0, lapack | G95, lapack]

Build from source codes

• Latest TGZ

  Installation Guide (in JAPANESE)

Software Requirements for developers

Following softwares should be installed for modification of source code and generation of documents. (But if you get tar.gz package, documentations are already generated).

• Modification of source code
  • Ruby
  • Rsed.rb: Recursive Sed with Ruby (in JAPANESE) (This is bundled in the tar.gz package)
• generation of documents
  • Individual HTML pages (Examples: This page, dcpam5 Documents, RAKURAKU dcpam5)
    • rdtool
    • rd2latex (This is bundled in the tar.gz package)
  • Reference Manual of modules
    • Enhanced version of RDoc Fortran90/95 parser
  • The governing equations and basic_equations, References for derivation
    • LaTeX
      • Style file: Dennou6 style (JAPANESE only)
    • latex2html_jp+dennou (JAPANESE only)

How to build

Extract TGZ Package

Make an empty directory, and extract archive as follows. A directory `dcpam5-version' created at the current working directory.

$ tar xvzf dcpam5_current.tgz

or

$ zcat dcpam5_current.tar.gz | tar -xvf -

Specify Fortran Compiler

Specify Fortran compiler to environmental variable FC . For example, if you use "frt",

• sh, bash

  $ FC=frt ; export FC

• csh, tcsh

  $ setenv FC frt

Specify Fortran compiler options for optimization and debug to environmental variable FFLAGS . For example, if you set options for automatic optimization and automatic parallelization to "frt",

• sh, bash

  $ FFLAGS="-Kfast,parallel" ; export FFLAGS

• csh, tcsh

  $ setenv FFLAGS "-Kfast,parallel"

Create `Config.mk'

Move created directroy, and excute ` ./configure '.

Specify library files in Libraries needed for compile to following options.

--with-ispack=ARG

ispack library filename (*.a)

--with-netcdf=ARG

netcdf library filename (*.a)

--with-gt4f90io=ARG

gt4f90io library filename (*.a)

--with-spml=ARG

spmodel library filename (*.a)

For exapmle, specify as follow. This command will generate Config.mk .

$ ./configure --with-ispack=/usr/local/lib/libisp.a \
              --with-netcdf=/usr/local/lib/libnetcdf.a \
              --with-gt4f90io=/usr/local/lib/gt4f90io/lib/libgt4f90io.a \
              --with-spml=/usr/local/lib/spml/lib/libspml.a \

GNU make is needed to build, so configure automatically inquires into GNU make in PATH. However, it returns error when GNU make is not found. In that case, please set the GNU make command for environment variable MAKE . And rerun execute ` ./configure '.

If you want to change directory to which the library and the module, etc. are installed, please set --help option as follow. Available options are showed.

$ ./configure --help

Descriptions about principal options are listed below.

--prefix=ARG

Specify prefix to ARG. Default value is /usr/local/dcpam5 .

--libdir=ARG

Specify directory to which the library is installed to ARG. Default value is /usr/local/dcpam5/lib .

--includedir=ARG

Specify directory to which the module is installed to ARG. Default value is /usr/local/dcpam5/include .

--bindir=ARG

Specify directory to which the executable file is installed to ARG. Default value is /usr/local/dcpam5/bin .

--with-docdir=ARG

Specify directory to which the documentation file is installed to ARG. Default value is /usr/local/dcpam5/doc .

--with-dcpam_lib_name=ARG

Specify dcpam5 library name to ARG. Library name becomes lib<ARG>.a . Default value is dcpam5 , so library name becomes libdcpam5.a .

--with-dcpam_suffix=ARG

Specify suffix of installdir, library name, executable files toARG. For example, you specify ffc5 when others are default, prefix of installdir becomes /usr/local/dcpam5-ffc5 , library name becomes libdcpam5-ffc5.a , executable files become gt4frt.ffc5 , gt4config.ffc5 .

--with-lang_conform_check=ARG

Specify language standard to ARG. And when you compile source code, check the language standard conformance. Now, "95" is valid. The compiler that can be used is limited.

--enable-debug

When you compile source code and execute binary file, output debug messages. The compiler that can be used is limited.

--config-cache or -C

config.cache is created at the same time as Config.mk 's being generated. config.cache stores information investigated with ./configure .

If you set this option, when you execute ./configure again, config.cache is loaded. If you want to ignore config.cache, don't set this option

For example, execute ./configure as follows.

$ ./configure -C  --enable-debug \
              --with-ispack=/usr/local/lib/libisp.a \
              --with-netcdf=/usr/local/lib/libnetcdf.a \
              --with-gt4f90io=/usr/local/lib/gt4f90io/lib/libgt4f90io.a \
              --with-spml=/usr/local/lib/spml/lib/libspml.a \

Then, information such as the locations of the netCDF library etc. is succeeded by executing ./configure as follows after next time.

$ ./configure -C

If you use Fujitsu Fortran compiler in Debian GNU/Linux, copy "Config.cache.debian-ffc*" to config.cache and execute ./configure . So, locations of libraries are specified automatically.

$ cp Config.cache.debian-ffc5 config.cache
$ ./configure

Edit `Config.mk'

Edit unspecified item in `Config.mk' manually.

Followings are main items.

FC

Fortran compiler

SYSFFLAGS

Flags needed when compiled and linked

SYSLDFLAGS

Flags needed when linked

SYSLDLIBS

Libraries needed when linked

DCPAMDIR

Specify location where Config.mk is.

prefix

Directory where dcpam5 library, modules, executable files, and documentations are installed

CLEAN_MODS

Extensions of Module Files used when "make clean"

MAKE

GNU make command

AR

Archive command

ARFLAGS

Flag of Archive command

RANLIB

Generate index to archive command

Compile source code

You must use GNU make to build. No other "make" program is acceptable. "make" tentatively means GNU make at the following. Replace them with GNU make of your system.

When ./configure is executed, the command name of GNU make is displayed as follows. Execute GNU make according to this message.

Execute GNU make in the current directory, as follows.

  /usr/bin/make

Generate documentations

To generate documentations, execute following command in current directory. If you get from dcpam5 TGZ package, documentations are already generated.

$ make doc

Execute a sample program

See RAKURAKU (easier) dcpam5.

DCPAM Development Group / GFD Dennou Staff