#= INSTALL guide of deepconv/arare # # Authors:: SUGIYAMA Ko-ichiro, ODAKA Masatsugu # Version:: $Id: INSTALL,v 1.12 2009-03-10 14:27:17 yamasita Exp $ # Tag Name: $Name: arare4-20100305 $ # Copyright:: Copyright (C) GFD Dennou Club, 2006. All rights reserved. # License:: See COPYRIGHT[link:COPYRIGHT] # ######################################################################## # =begin JA = deepconv/arare インストール手引 #* 杉山 耕一朗, 小高 正嗣, 山下 達也 # * 2009/03/06 (山下 達也) 最終更新 # * 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, Tatsuya Yamashita # * 2009/03/06 (Tatsuya Yamashita) Update # * 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) (()) (2) (()) (3) (()) (4) (()) =end EN =begin JA == 動作環境 2009 年 03 月 06 日現在, 以下の環境での動作が確認されています. === Linux on x86 * Debian GNU/Linux 5.0 (lenny) + g95 + LAPACK + mpich2 * Debian GNU/Linux 5.0 (lenny) + ifort (ver.11.0) + lapack + mpich2 * Debian GNU/Linux 4.0 (etch) + (()) (ver.5) + LAPACK * Debian GNU/Linux 4.0 (etch) + g95 + LAPACK === Mac OS on Intel Mac * Mac OS 10.5 + g95 + LAPACK === 大型計算機 * CRAY XT4 + PGI compiler + LAPACK * 日立 SR11000 + 日立最適化 Fortran + LAPACK/MATRIX * NEC SX6 + sxf90 + LAPACK * NEC SX8 + sxf90 + LAPACK =end JA =begin EN == Supported system Deepconv can be compiled and run on following platforms (2009-03-06). === Linux on x86 * Debian GNU/Linux 5.0 (lenny) + g95 + LAPACK + mpich2 * Debian GNU/Linux 5.0 (lenny) + ifort (ver.11.0) + LAPACK + mpich2 * Debian GNU/Linux 4.0 (etch) + (()) (ver.5) + LAPACK * Debian GNU/Linux 4.0 (etch) + g95 + LAPACK === Mac OS on Intel Mac * Mac OS 10.5 + g95 + LAPACK === Super Computer System * CRAY XT4 + PGI compiler + LAPACK * HITACHI SR11000 + HITACHI Optimized Fortran + LAPACK/MATRIX * NEC SX6 + sxf90 + LAPACK * NEC SX8 + sxf90 + LAPACK =end EN =begin JA == コンパイルに必要なソフトウェア deepconv/arare をインストールと実行には以下のソフトウェアを事前にインストール しておく必要があります. : (()) (バージョン 3.6.x) ソースからコンパイルする場合 * ((<ソースの TGZ|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/>)) [(())] [(())] # Debian GNU/Linux を使用しており, バイナリパッケージを利用する場合 # # * debian パッケージ # [(()) | # (()) | # (())] # 上記 deb パッケージの他に netCDF の Development kit # (netcdfg-dev パッケージ) もインストールする必要があります. : (()) ソースからコンパイルする場合 * (()) [((<インストールガイドの目次|URL:http://www.gfd-dennou.org/library/gtool/gtool5/gtool5_current/INSTALL.htm>))] # Debian GNU/Linux を使用しており, # バイナリパッケージを利用する場合 # # * debian パッケージ # [(())] : LAPACK/BLAS ソースからコンパイルする場合 * (()) * (()) # Debian GNU/Linux を使用しており, # バイナリパッケージを利用する場合 # # * debian パッケージ # [(()) # | # (())] == ドキュメントのコンパイルに必要なソフトウェア 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 * (()) * (()) =end JA =begin EN == Required softwares : (()) (version 3.6.x) For user who builds binary from source archive * (()) [(())] [(())] For Debian GNU/Linux users * debian packages [(()) | (()) | (())] In addition to these package, netCDF development kit packages (netcdfg-dev) is also required. : (()) For user who builds binary from source archive * (()) [(())] For Debian GNU/Linux 3.1 (sarge) users * debian package [(())] : LAPACK/BLAS For user who builds binary from source archive * (()) * (()) For Debian GNU/Linux 3.1 (sarge) users * debian package [(()) | (())] == 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 * (()) * (()) =end EN =begin JA == インストールの手順 === ソースの入手 wget などでソースを入手 $ wget http://www.gfd-dennou.org/library/deepconv/arare/arare4_current.tgz === tgz ファイルの展開, ソースディレクトリへの移動 $ tar -xzvf arare4_current.tgz $ cd arare4-YYYYMMDD === 環境変数の設定 コンパイラを指定する. $ export FC=(コンパイラ名) 例えば g95 の場合, $ export FC=g95 とする. 並列計算を行いたい場合には $ export FC=mpif90 とする. === Mkinclude の作成 ソースを展開後, configure を実行して Mkinclude ファイルを作成する. $ ./configure \ --with-netcdf=(netCDF ライブラリファイルの絶対パス) \ --with-gtool5=(gtool5 ライブラリファイルの絶対パス) \ --with-lapack=(LAPACK ライブラリファイルの絶対パス) \ --with-blas=(BLAS ライブラリファイルの絶対パス) 例えば Debian パッケージを利用している場合, $ ./configure \ --with-netcdf=/usr/lib/libnetcdf-g95.a \ --with-gtool5=/usr/lib/gtool5-g95/lib/libgtool5.a \ --with-lapack=/usr/lib/liblapack-g95.a \ --with-blas=/usr/lib/libblas-g95.a とすれば良い. 並列計算を行う場合には, gtool5 を mpif90 でコンパイルしておく. デフォルトでは線形計算ライブラリとして LAPACK と BLAS を用いるように なっている. その他のライブラリを利用する場合は, 環境変数 LINSOLV に を指定して, 以下のように実行する. $ LINSOLV=(線形計算ライブラリ名) ./configure \ --with-netcdf=(netCDF ライブラリファイルの絶対パス) \ --with-gtool5=(gtool5 ライブラリファイルの絶対パス) \ --with-library=(使用する線形計算ライブラリファイルの絶対パス) 作成した Mkinclude の各マクロを確認し, インストール先の環境にあわせて 適宜編集する. 注) 2009 年 03 月 11 日現在, LAPACK, BLAS 以外の線形計算ライブラリ として利用可能なのは, HITACHI SR11000 にインストールされている MATRIX だけである. これを使用する場合は LINSOLV=matrix を指定する. === ソースのコンパイル コンパイルは GNU make を用いて行う. ==== 2 次元計算を行なう場合 : (1) 逐次版 ソースツリー直下で $ make を実行するとソース直下の以下のディレクトリに実行ファイルとライブラリ, モジュールファイルが展開される. ./lib ライブラリ libarare.a が格納される ./bin 実行ファイルが格納される ./include 各種 *.mod ファイルが格納される bin 以下には次の実行ファイルが格納される. arare 2 次元雲対流モデル arare_jupiter 2 次元雲対流モデル(木星の化学反応を考慮したもの) randomset 初期値用乱数設定コマンド (2 次元モデル用) : (2) 逐次版( 2 次元主成分凝結対流の計算を行なう場合) ソースツリー直下で $ make mmc を実行するとソース直下の以下のディレクトリに実行ファイルとライブラリ, モジュールファイルが展開される. ./lib ライブラリ libarare.a が格納される ./bin 実行ファイルが格納される ./include 各種 *.mod ファイルが格納される bin 以下には次の実行ファイルが格納される. arare 2 次元雲対流モデル(火星用) randomset 初期値用乱数設定コマンド (2 次元モデル用) : (3) 並列版 ソースツリー直下で $ make mpi を実行するとソース直下の以下のディレクトリに実行ファイルとライブラリ, モジュールファイルが展開される. ./lib ライブラリ libarare.a が格納される ./bin 実行ファイルが格納される ./include 各種 *.mod ファイルが格納される bin 以下には次の実行ファイルが格納される. ararempi 2 次元雲対流モデル(mpi 用) randomset 初期値用乱数設定コマンド (2 次元モデル用) ==== 3 次元計算を行なう場合 ソースツリー直下で $ make 3d を実行するとソース直下の以下のディレクトリに実行ファイルとライブラリ, モジュールファイルが展開される. ./lib ライブラリ libarare.a が格納される ./bin 実行ファイルが格納される ./include 各種 *.mod ファイルが格納される bin 以下には次の実行ファイルが格納される. arare_3d 3 次元雲対流モデル(湿潤大気用) ※ 2009 年 03 月 11 日現在, 開発中. arare_3d_dry 3 次元対流モデル(乾燥大気用) randomset_3d 初期値用乱数設定コマンド (3 次元モデル用) === ドキュメントのコンパイル ==== インストールの手引, 利用の手引とコードリファレンス $ make doc ==== 数理モデル解説と離散モデル解説 $ make latex2html =end JA =begin EN == Installation === Setting of environment variable Set an environment variable of a compiler. $ export FC=(compiler name) === Make Mkinclude file Execute configure script at the top directory of source tree. $ ./configure \ --with-netcdf=(netCDF library file) \ --with-gtool5=(gtool5 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-gtool5=(gtool5 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 ファイル(木星設定, バージョン 1) arare-jupiter2.conf サンプル NAMELIST ファイル(木星設定, バージョン 2) arare-mmc.conf サンプル NAMELIST ファイル(火星湿潤対流設定) arare_3d.conf サンプル NAMELIST ファイル(3 次元設定) bin/ 実行ファイル格納ディレクトリ (コンパイル時に作成) css/ スタイルシート格納ディレクトリ doc/ ドキュメント格納ディレクトリ dai1bu/ 数理モデル解説格納ディレクトリ dai2bu/ 離散モデル解説格納ディレクトリ code_reference/ コードリファレンス格納ディレクトリ include/ モジュール格納ディレクトリ (コンパイル時に作成) lib/ ライブラリ格納ディレクトリ (コンパイル時に作成) src/ ソースコード格納ディレクトリ Makefile Makefile chemdat/ 化学種の指定および物性値の設定と計算 dynamic/ 力学過程 env/ 基本場と擾乱場の初期条件を設定 io/ 入出力 main/ 主プログラム, 乱数生成, 診断量の計算 moist/ 湿潤物理過程 physics/ 物理過程 setup/ 初期化 util/ 平均微分演算, 境界条件等を計算する下請け計算 src-mmc/ ソースコード格納ディレクトリ(火星湿潤対流用) 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, Version 1) arare-jupiter2.conf Sample of NAMELIST file (for Jupiter, Version 2) arare-mmc.conf Sample of NAMELIST file (for the Martian Moist Convection) arare_3d.conf Sample of NAMELIST file (for 3D) 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 src-mmc/ Source code directory for calculation of Martian Moist Convection 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