Deepconv/arare installation guide

  1. Operation Environment
  2. Required Softwares
  3. How to Build
  4. Major files and directories in source tree

Operation Environment

This program is operated by following compilers.

Notes about some compilers that are done the operation check or have done are as follows. Read it through if the following operation check doesn't go well, because it is likely to apply about other compilers.

Required Softwares

netCDF (version 3.6.x)
gtool5
LAPACK/BLAS
MPI library

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).

How to Build

Download source code.

Download source code by using wget command, and so on.

$ wget http://www.gfd-dennou.org/library/deepconv/arare/arare5_current.tgz

Unpack tgz file and go to source tree directory.

$ tar -xzvf arare5_current.tgz
$ cd arare5-YYYYMMDD

Setting of environment variable

Set an environment variable of a compiler.

$ export FC=(compiler name)

Create Config.mk

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

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

--with-netcdf=ARG
netcdf library filename (*.a)
--with-gtool5=ARG
gtool5 library filename (*.a)
--with-lapack=ARG
lapack library filename (*.a)
--with-blas=ARG
blas library filename (*.a)
--with-mpi
using MPI

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

$ ./configure \
   --with-netcdf=(netCDF library file) \	
   --with-gtool5=(gtool5 library file) \
   --with-lapack=(LAPACK library file) \
   --with-blas=(BLAS library file) 

If you use MPI, then,

$ ./configure \
   --with-netcdf=(netCDF library file) \	
   --with-gtool5=(gtool5 library file) \
   --with-lapack=(LAPACK library file) \
   --with-blas=(BLAS library file)  \
   --with-mpi

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 '

Debian packages

If using Debian package, please specify as follow.

$ export FC=gfortran
$ ./configure

Edit `Config.mk'

A file ' Config.mk ' in which elemental settings are written is created by above "configure". However, the settings may be insufficient by "configure" in some environments. In that case, edit ' Config.mk ' manually according to need.

Followings are main items.

FC
Fortran compiler
CPPFLAGS
Flags needed for PreProcessor. If using MPI, CPPFLAGS = LIB_MPI.
SYSFFLAGS
Flags needed when compiled and linked (we recommend following option; pgfortran => -Kieee, ifort => -fp-model strict -prec-div).
SYSLDFLAGS
Flags needed when linked
SYSLDLIBS
Libraries needed when linked
prefix
Directory where deepconv library, modules, executable files, and documentations are installed
MAKE
GNU make command
AR
Archive command
ARFLAGS
Flag of Archive command
RANLIB
Generate index to archive command

Compile

Execute "make" command at the top directory of source tree.

$ make 

Execute "make doc" at the top directory of source tree to build installation guide, code reference and tutorial.

$ make doc  

Uninstall

Execute "make clean" to remove binary files.

$ make clean

Execute "make doc" at the top directory of source tree to remove installation guide, code reference and tutorial.

$ make clean.doc

All of them and Config.mk are removed by "make clean.all".

$ make clean.all