#
# IGMTool Installation Guide in RD (Ruby Document) format
#
# For instruction of installing IGModel-SW,
# see "INSTALL.htm.en" (English) or "INSTALL.htm" (Japanese)
# included in "IGMBaseLib1.x.x" tar.gz package
# available from http://www.gfd-dennou.org/memeber/ykawai/work/IGModel.htm.
# Otherwise, see this file directly, or generate
# above mentioned html files with "make guide"
# in current directory after installing rdtool
# .
=begin JA
= IGModel-SW インストールガイド
=end JA
=begin EN
= IGModel-SW Installation Guide
=end EN
=begin JA
== 動作環境
このプログラムは, 2011 年 09 月 23 日現在, 以下の環境で動作確認をしています.
=end JA
=begin EN
== Supported system
This programs can be compiled and run on following platforms(2011-09-23).
=end EN
=begin
* ((<"Ubuntu 11.04 "|URL:http://www.ubuntu.com/>)) +
(())
* ((<"Ubuntu 11.04 "|URL:http://www.ubuntu.com/>)) +
(())
=end
==begin JA
== コンパイルに必要なソフトウエア
IGMBaseLib のインストールおよび利用には, 以下のソフトウエアを事前にインストールしておく必要があります.
: (()) (バージョン 3.6.x)
ソースからコンパイルする場合
* ((<ソースの TGZ|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/>))
[(())]
[(())]
: (())
ソースからコンパイルする場合
* (())
[((<インストールガイドの目次|URL:http://www.gfd-dennou.org/library/gtool/gtool5/gtool5_current/INSTALL.htm>))]
: (())
ソースからコンパイルする場合
* 最新版の IGMBaseLib1 の取得は, この((<リンク先のページ|URL:http://www.gfd-dennou.org/member/ykawai/work/IGMBaseLib.htm/>))からできます.
=end JA
=begin EN
== Required softwares
: (()) (version 3.6.x)
For user who builds binary from source archive
* (())
[(())]
[(())]
: (())
For user who builds binary from source archive
* (())
[(())]
: (())
For user who builds binary from source archive
* You can get the latest IGMBaseLib1 from the following (()).
=end EN
=begin JA
== インストールの手順
=== ソースコードの入手
wget などを使って, ソースコードを取得します.
$ wget http://www.gfd-dennou.org/ftp/member/ykawai/work/IGMTool/dist/igmodelsw-1.x.x.tar.gz
=== tgz ファイルの展開, プロジェクトディレクトリへの移動
$ tar -xzvf igmodelsw-1.x.x.tar.gz
$ cd igmodelsw-1.x.x.tar.gz
=== 環境変数の設定
ビルドに用いるコンパイラを指定します.
$ export FC=(コンパイラ名)
また, コンパイルオプションを指定する場合には,
$ export FCFLAGS=(コンパイルオプション)
とします.
例えば Fortran コンパイラとして gfortran を用いる場合には,
$ export FC=gfortran
$ export FCFLAGS=-O2
のように指定します.
#並列計算を行いたい場合には
#
# $ export FC=mpif90
#
#とする.
=== Makefile の生成
トップディレクトリにて configure を実行して, 各ディレクトリ内に Makefile を自動生成します.
$ ./configure \
--prefix=(インストールディレクトリの絶対パス)
--with-netcdf=(NetCDF ライブラリファイルの絶対パス) \
--with-netcdff=(Fortran90 用 NetCDF ライブラリファイルの絶対パス) \
--with-gtool5=(gtool5 ライブラリファイルの絶対パス)
--with-IGMBaseLib1=(IGMBaseLib1 ライブラリファイルの絶対パス)
例えば Debian パッケージを利用している場合,
$ ./configure \
--prefix=/usr/local/IGMTool1.x.x \
--with-netcdf=/usr/lib/libnetcdf.a \
--with-netcdf=/usr/lib/libnetcdff.a \
--with-gtool5=/usr/lib/libgtool5.a
--with-gtool5=/usr/local/IGMBaseLib1/lib/libIGMBaseLib.a
=== ソースコードのコンパイル
IGModel-SW のビルドには, GNU make を用います.
IGModel-SW のディレクトリのトップレベルで, 以下のコマンドを実行してください.
$ make
#=== ドキュメントの生成
#=== テストプログラム実行の手順
#IGModel-SW のディレクトリのトップレベルで, 以下のコマンドを実行してください.
#
# $ make test
#
#全てのテストプログラムが正常に終了すれば, '*** All unit tests are succeeded !!' と表示されます.
=== インストール
ディレクトリのトップレベルで, 以下のコマンドを実行します.
インストールディレクトリとしてシステム領域を指定している場合には, 管理者権限が必要となります.
$ make install
=end JA
=begin EN
== How to install
=== Getting source code
To download the source code of IGModel-SW
$ wget http://www.gfd-dennou.org/ftp/member/ykawai/work/IGMTool/dist/igmodelsw-1.x.x.tar.gz
=== Expand tar.tgz file and move to project directory
$ tar -xzvf igmodelsw-1.x.x.tar.gz
$ cd igmodelsw-1.x.x.tar.gz
=== Setting of envrinment variables
Specify an environment variable of a compiler.
$ export FC=(compiler name)
If you want to set the compiler options,
$ export FCFLAGS=(compiler options)
For example, in the case of using gfortran as a Fortran compiler,
$ export FC=gfortran
$ export FCFLAGS=-O2
#並列計算を行いたい場合には
#
# $ export FC=mpif90
#
#とする.
=== Generate Makefile
Execute the configure scipt at the top directory,
and automagically generate Makefile in each directory.
$ ./configure \
--prefix=(full path to the install directory)
--with-netcdf=(full path to the NetCDF library file) \
--with-netcdff=(full path to the NetCDF library file for Fortran 90) \
--with-gtool5=(full path to the gtool5 library file)
--with-IGMBaseLib1=(full path to the IGMBaseLib1 library file)
For example, in the case of using Debian pacakges,
$ ./configure \
--prefix=/usr/local/IGMTool1.x.x \
--with-netcdf=/usr/lib/libnetcdf.a \
--with-netcdf=/usr/lib/libnetcdff.a \
--with-gtool5=/usr/lib/libgtool5.a
--with-IGMBaseLib1=/usr/local/IGMBaseLib1.x.x/lib/libIGMBaseLib.a
=== Compile Sources
In order to build IGModel-SW, GNU make is used.
Execute the following command at the top directory.
$ make
=== Generate Documents
#=== Run test programs
#Execute the following command at the top directory of IGModel-SW.
#
# $ make test
#
#If all test program are succeeded, '*** All unit tests are succeeded !!' will be outputted.
=== Install
Execute the following command at the top directory.
If you choose the administration domain where IGModel-SW is installed,
this installation may require administrative access to your computer.
$ make install
=end EN