#= INSTALL guide of deepconv/arare
#
# Authors:: SUGIYAMA Ko-ichiro, ODAKA Masatsugu
# Version:: $Id: INSTALL,v 1.9 2008-01-17 07:48:27 odakker Exp $
# Tag Name: $Name: arare4-20080618-2 $
# Copyright:: Copyright (C) GFD Dennou Club, 2006. All rights reserved.
# License:: See COPYRIGHT[link:COPYRIGHT]
#
########################################################################
#
=begin JA

= deepconv/arare インストール手引

#* 杉山 耕一朗, 小高 正嗣
#  * 2008/01/17  (小高 正嗣) 最終更新
#  * 2007/10/19  (小高 正嗣) 最終更新
#  * 2006/10/30  (小高 正嗣) 最終更新
#  * 2006/09/29  (小高 正嗣) 最終更新
#  * 2006/09/20  (小高 正嗣) 最終更新
#  * 2006/09/12  (小高 正嗣) 最終更新
#  * 2006/03/16  (杉山 耕一朗) 最終更新
#  * 2005/04/26  (小高 正嗣) 最終更新
#  * 2005/04/22  (杉山 耕一朗) 最終更新
#  * 2005/04/19  (杉山 耕一朗) 更新
#  * 2005/01/31  (小高 正嗣) 新規作成

(1) ((<動作環境>))
(2) ((<コンパイルに必要なソフトウェア>))
(3) ((<インストールの手順>))
(4) ((<ソースツリー以下の主要なファイルとディレクトリ>))

=end JA

=begin EN

= Deepconv/arare installation guide

#* Ko-ichiro Sugiyama, Masatsugu Odaka
#  * 2007/10/19  (Masatsugu Odaka) Update
#  * 2006/10/30  (Masatsugu Odaka) Update
#  * 2006/09/29  (Masatsugu Odaka) Update
#  * 2006/09/20  (Masatsugu Odaka) Update
#  * 2006/09/12  (Masatsugu Odaka) Update
#  * 2006/03/16  (Ko-ichiro Sugiyama) Update
#  * 2005/04/26  (Masatsugu Odaka) Update
#  * 2005/04/22  (Ko-ichiro Sugiyama) Update
#  * 2005/04/19  (Ko-ichiro Sugiyama) Update
#  * 2005/01/31  (Masatsugu Odaka) Initial release

(1) ((<Supported system>))
(2) ((<Required softwares>))
(3) ((<Installation>))
(4) ((<Major files and directories in source tree>))


=end EN

=begin JA

== 動作環境

2007 年 10 月 19 日現在, 以下の環境での動作が確認されています.

=== Linux on x86

 * Debian GNU/Linux 3.1 (sarge) + 
   ((<FQS Fortran90|URL:http://www.fqs.co.jp/fort-c/>)) (ver.5) 
   + LAPACK	

 * Debian GNU/Linux 3.1 (sarge) + g95 + LAPACK

=== Mac OS on Intel Mac

 * Mac OS 10.5 + g95 + LAPACK

=== 大型計算機

 * 日立 SR11000 + 日立最適化 Fortran + LAPACK/MATRIX
 * NEC SX6 + sxf90 + LAPACK

=end JA
=begin EN
== Supported system

Deepconv can be compiled and run on following platforms (2007-10-19).

=== Linux on x86

 * Debian GNU/Linux 3.1 (sarge) + 
   ((<FQS Fortran90|URL:http://www.fqs.co.jp/fort-c/>)) (ver.5) 
   + LAPACK	

 * Debian GNU/Linux 3.1 (sarge) + g95 + LAPACK

=== Mac OS on Intel Mac

 * Mac OS 10.5 + g95 + LAPACK

=== Super Computer System 

 * HITACHI SR11000 + HITACHI Optimized Fortran + LAPACK/MATRIX
 * NEC SX6 + sxf90 + LAPACK

=end EN

=begin JA
== コンパイルに必要なソフトウェア

deepconv/arare をインストールと実行には以下のソフトウェアを事前にインストール
しておく必要があります. 


: ((<netCDF|URL:http://www.unidata.ucar.edu/software/netcdf/>)) (バージョン 3.6.0, 3.6.1, 3.6.2)

  ソースからコンパイルする場合
  * ((<ソースの TGZ|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/netcdf-3.6.2.tar.gz>))

    [((<Unidata 本家 NetCDFクイックインストールガイド (英語) |URL:http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/Quick-Instructions-for-Installing-NetCDF-on-Unix.html#Quick-Instructions-for-Installing-NetCDF-on-Unix>))
    |
    ((<(日本語訳)|URL:INSTALL_netcdf.htm>)) ]

    [((<Unidata 本家のインストールガイドの目次|URL:http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/index.html>))]
  
  Debian GNU/Linux 3.1 (sarge) を使用しており,  バイナリパッケージを利用する場合

  * debian パッケージ
    [((<FQS Fortran90 ver5|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/>)) |
    ((<Intel ifc ver9|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/>)) |
    ((<g95|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf-g95/sarge/>))]

    上記 deb パッケージの他に netCDF の Development kit 
    (netcdfg-dev パッケージ) もインストールする必要があります.

: ((<gt4f90io ライブラリ|URL:http://www.gfd-dennou.org/library/gtool4/>))

  ソースからコンパイルする場合
  * ((<gt4f90io ソースのTGZ|URL:http://www.gfd-dennou.org/library/gtool4/gt4f90io/gt4f90io_current.tgz>))
    [((<インストールガイドの目次|URL:http://www.gfd-dennou.org/library/gtool4/gt4f90io/gt4f90io_current/INSTALL.htm>))]

  Debian GNU/Linux 3.1 (sarge) を使用しており, 
  バイナリパッケージを利用する場合

  * debian パッケージ 
    [((<URL:http://www.gfd-dennou.org/library/gtool4/debian.htm>))]



: LAPACK/BLAS

  ソースからコンパイルする場合
  * ((<LAPACK ソースの TGZ|URL:http://www.netlib.org/lapack/>)) 
  * ((<BLAS ソースの TGZ|URL:http://www.netlib.org/blas/>)) 

  Debian GNU/Linux 3.1 (sarge) を使用しており, 
  バイナリパッケージを利用する場合

  * debian パッケージ 
    [((<FQS Fortran90 ver5 版|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/lapack-ffc5/sarge/>))
    |
    ((<g95 版|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/lapack-g95/sarge/>))]


== ドキュメントのコンパイルに必要なソフトウェア

deepconv/arare のドキュメントは, 数理モデルと離散モデル解説は LaTex,  
コードリファレンスは RD, RDOC (Ruby Document) を用いて記述されています.

これらのドキュメントはソースツリー内ではコンパイル済となっていますが,
ドキュメントの再コンパイルを行うためには, 以下のソフトウェアが必要です.

* LaTeX とそのスタイルファイル
  * ASCII pTeX など
  * dennou-sty-6 ((<"http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/"|URL:http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/>))
  * dennou-sty-6 対応 latex2html ((<"http://www.gfd-dennou.org/library/cc-env/latex2html/"|URL:http://www.gfd-dennou.org/library/cc-env/latex2html/>))

* ruby/rd
  * rdtool ((<"http://raa.ruby-lang.org/project/rdtool/"|URL:http://raa.ruby-lang.org/project/rdtool/>))
  * rd2html-ext ((<"http://raa.ruby-lang.org/project/rd2html-ext/"|URL:http://raa.ruby-lang.org/project/rd2html-ext/>))
  * ((<"RDOC Fortran90/95 ソースコード解析機能強化版"|URL:http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/>)) 


Debian GNU/Linux を使用する場合, 以下のバイナリパッケージが必要となります.
* librd-html-ext-ruby1.8
* rdtool
* rdoc 
* ((<rdoc-f95|URL:http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/debian/>))
* ((<dennou-sty-6|URL:http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/>))

=end JA
=begin EN

== Required softwares

: ((<netCDF|URL:http://www.unidata.ucar.edu/software/netcdf/>)) (version 3.6.0. 3.6.1, 3.6.2)

  For user who builds binary from source archive
  * ((<TGZ file of netCDF|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/netcdf-3.6.2.tar.gz>))

    [((<NetCDF quick installation guide|URL:http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/Quick-Instructions-for-Installing-NetCDF-on-Unix.html#Quick-Instructions-for-Installing-NetCDF-on-Unix>))]

    [((<Index of installation guide|URL:http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/index.html>))]

  
  For Debian GNU/Linux 3.1 (sarge) users
  * debian packages
    [((<compiled by FQS Fortran90 ver5|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/>)) |
    ((<compiled by Intel ifc ver9|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/>)) |
    ((<compiled by g95|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf-g95/sarge/>))]

    In additoin to these package, netCDF development kit packages (netcdfg-dev)
    is also required.


: ((<gt4f90io|URL:http://www.gfd-dennou.org/library/gtool4/>))

  For user who builds binary from source archive
  * ((<TGZ file of gt4f90io|URL:http://www.gfd-dennou.org/library/gtool4/gt4f90io/gt4f90io_current.tgz>))
    [((<Index of installation guide|URL:http://www.gfd-dennou.org/library/gtool4/gt4f90io/gt4f90io_current/INSTALL.htm>))]

  For Debian GNU/Linux 3.1 (sarge) users
  * debian package [((<URL:http://www.gfd-dennou.org/library/gtool4/debian.htm.en>))]



: LAPACK/BLAS

  For user who builds binary from source archive
  * ((<TGZ file of LAPACK|URL:http://www.netlib.org/lapack/>)) 
  * ((<TGZ file of BLAS |URL:http://www.netlib.org/blas/>)) 

  For Debian GNU/Linux 3.1 (sarge) users
  * debian package 
    [((<compiled by FQS Fortran90 ver5|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/lapack-ffc5/sarge/>))
    |
    ((<compiled by g95|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/lapack-g95/sarge/>))]


== Required softwares to build documentation 

Documentations of deepconv/arare are written by using LaTex, RD, and RDOC (Ruby Document). 

All documentations in source tree are already compiled. If you recompile 
documentations, following softwares are requaired.

* LaTeX and style files
  * ASCII pTeX 
  * dennou-sty-6 ((<"http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/"|URL:http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/>))
  * latex2html with dennou-sty-6 style((<"http://www.gfd-dennou.org/library/cc-env/latex2html/"|URL:http://www.gfd-dennou.org/library/cc-env/latex2html/>))

* ruby/rd
  * rdtool ((<"http://raa.ruby-lang.org/project/rdtool/"|URL:http://raa.ruby-lang.org/project/rdtool/>))
  * rd2html-ext ((<"http://raa.ruby-lang.org/project/rd2html-ext/"|URL:http://raa.ruby-lang.org/project/rd2html-ext/>))
  * ((<"Enhanced version of RDoc Fortran 90/95 parser"|URL:http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/>)) 


If you use Debian GNU/Linux on x86, followng packages are required:
* librd-html-ext-ruby1.8
* rdtool
* rdoc 
* ((<rdoc-f95|URL:http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/debian/>))
* ((<dennou-sty-6|URL:http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/>))

=end EN

=begin JA
== インストールの手順

=== Mkinclude の作成

ソースを展開後, configure を実行して Mkinclude ファイルを作成する.

  $ ./configure \
    --with-netcdf=(netCDF ライブラリファイルの絶対パス) \	
    --with-gt4f90io=(gt4f90io ライブラリファイルの絶対パス) \
    --with-lapack=(LAPACK ライブラリファイルの絶対パス) \
    --with-blas=(BLAS ライブラリファイルの絶対パス) 

デフォルトでは線形計算ライブラリとして LAPACK と BLAS を用いるように
なっている. その他のライブラリを利用する場合は, 環境変数 LINSOLV に
を指定して, 以下のように実行する.

  $ LINSOLV=(線形計算ライブラリ名) ./configure \
    --with-netcdf=(netCDF ライブラリファイルの絶対パス) \	
    --with-gt4f90io=(gt4f90io ライブラリファイルの絶対パス) \
    --with-library=(使用する線形計算ライブラリファイルの絶対パス) 

作成した Mkinclude の各マクロを確認し, インストール先の環境にあわせて
適宜編集する.

  注) 2006 年 10 月 30 日現在, LAPACK, BLAS 以外の線形計算ライブラリ
  として利用可能なのは, HITACHI SR11000 にインストールされている 
  MATRIX だけである. これを使用する場合は LINSOLV=matrix を指定する.


=== ソースのコンパイル

コンパイルは Make を用いて行う. ソースツリー直下で

	$ make 
  
とすると, ソース直下の以下のディレクトリに実行ファイルとライブラリ, 
モジュールファイルが展開される.

	./lib		ライブラリ libarare.a が格納される
	./bin		実行ファイルが格納される
	./include	各種 *.mod ファイルが格納される
	
bin 以下に格納される実行ファイルは以下の 3 つである.

	arare           2 次元雲対流モデル
	arare_3d        3 次元雲対流モデル
	arare-anal	診断量解析コマンド
	randomset	初期値用乱数設定コマンド (2 次元モデル用)
	randomset_3d	初期値用乱数設定コマンド (3 次元モデル用)


=== ドキュメントのコンパイル

インストールの手引, 利用の手引とコードリファレンスのコンパイルは

	$ make doc  

とすると行われる. 

数理モデル解説と離散モデル解説のコンパイルは

	$ make latex2html

とすると行われる. 

=end JA
=begin EN

== Installation 

=== Make Mkinclude file

Execute configure script at the top directory of source tree.

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

If you want to use other library of linear algebra, 
specify the library name to LINSOLV and execute configure script as follows.

  $ LINSOLV=(Name of the linear algebra library) ./configure \
    --with-netcdf=(netCDF library file) \	
    --with-gt4f90io=(gt4f90io library file) \
    --with-library=(Linear algebra library file) 


And the confirm Mkinclude and modify suitable for your platform.

  Note) Supported linear algebra library except for LAPACK/BLAS is 
  only MATRIX on HITACHI SR11000. In this case, specify LINSOLV="matrix". 


=== Compile

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

	$ make 
  

=== Compile documentation file 

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

	$ make doc  

Execute "make latex2html" at the top directory of source tree to build
html documentation file of physical model and discritization method.

	$ make latex2html


=end EN

=begin JA
== アンインストールの手順

src ディレクトリ以下のオブジェクトファイル, 実行ファイルの消去は

	$ make clean

とする.

インストールの手引, 利用の手引とコードリファレンスの消去は

	$ make clean.doc

とする. 数理モデル解説と離散モデル解説の消去は

	$ make clean.latex2html

とする. 


	$ make clean.all

とすると, 上記のすべてと Mkinclude ファイルが消去される.

=end JA
=begin EN
== 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

Execute "make latex2html" at the top directory of source tree to remove
html documentation file of physical model and discritization method.

	$ make clean.latex2html

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

	$ make clean.all

=end EN

=begin JA
== ソースツリー以下の主要なファイルとディレクトリ

   COPYRIGHT	 ライセンス
   INSTALL.rd	 このファイル
   Makefile	 Makefile
   Mkinclude	 Makefile 用 include ファイル (configure から生成)

   arare-earth.conf	サンプル NAMELIST ファイル(地球設定)
   arare-jupiter.conf	サンプル NAMELIST ファイル(木星設定)

   bin/		 実行ファイル格納ディレクトリ (コンパイル時に作成)
   css/		 スタイルシート格納ディレクトリ
   doc/		 ドキュメント格納ディレクトリ
      dai1bu/	 数理モデル解説格納ディレクトリ
      dai2bu/	 離散モデル解説格納ディレクトリ
      code_reference/	 コードリファレンス格納ディレクトリ
   include/	 モジュール格納ディレクトリ (コンパイル時に作成)
   lib/		 ライブラリ格納ディレクトリ (コンパイル時に作成)
   src/		 ソースコード格納ディレクトリ
       Makefile  Makefile
       chemdat/  化学種の指定および物性値の設定と計算
       dynamic/  力学過程
       env/      基本場と擾乱場の初期条件を設定
       io/       入出力
       main/     主プログラム, 乱数生成, 診断量の計算
       moist/    湿潤物理過程
       physics/  物理過程
       setup/    初期化
       util/     平均微分演算, 境界条件等を計算する下請け計算

   sysmake/      Mkinclude のテンプレート置き場 (廃止予定)
       Mkinclude.ffc  ffc 用のテンプレート
       Mkinclude.g95  g95 用のテンプレート

   tools/	解析や絵を描くのに使うツール群

=end JA
=begin EN

== Major files and directories in source tree

   COPYRIGHT	 Licence file
   INSTALL.rd	 This file
   Makefile	 Makefile
   Mkinclude	 Include file for Makefile (made by configure script)

   arare-earth.conf	Sample of NAMELIST file (for the Earth)
   arare-jupiter.conf	Sample of NAMELIST file (for Jupiter)

   bin/		 Binary file directory
   css/		 CSS file directory
   doc/		 Documentation directory
      dai1bu/	 Documentation of physical model 
      dai2bu/	 Documentation of method of discritization
      code_reference/	 Code reference
      tutorial/  Tutorial
   include/	 Mod file directory
   lib/		 Library file directory
   src/		 Source code directory
       Makefile  Makefile
       chemdat/  Setup for chemical data
       dynamic/  Dynamical process
       env/      Setup for initial condition
       io/       Input/Output
       main/     Main program
       moist/    Moist process
       physics/  Physical processes
       setup/    Initial setup
       util/     Low level routines

   sysmake/      Mkinclude template-file directory (obsolete)
       Mkinclude.ffc  for FQS Fortran90 compiler on Linux
       Mkinclude.g95  for g95

   tools/	 Tools for draw figure and analysis


=end EN