# # gt4f90io Installation Guide in RD (Ruby Document) format # # For instruction of installing gt4f90io, see "INSTALL.htm.en" # (written in English) or "INSTALL.htm" (written in Japanese) # included in "gt4f90io" TGZ package available from # . # Otherwise, see this file directly, or generate # above mentioned html files with "make guide" # in current directory after installing rdtool # . =begin TOPLINK [(()) | (())] [(()) | (())] [(())] =end TOPLINK =begin JA = gt4f90io インストールガイド # * 森川 靖大 (morikawa), 豊田 英司 (toyoda), 小高 正嗣 (odakker) # * $Id: INSTALL,v 1.8 2006/01/17 11:21:57 morikawa Exp $ =end JA =begin EN = Gt4f90io Installation Guide # * Yasuhiro MORIKAWA (morikawa), Eizi TOYODA (toyoda), Masatsugu ODAKA (odakker) # * $Id: INSTALL,v 1.8 2006/01/17 11:21:57 morikawa Exp $ =end EN =begin JA == 動作環境 このプログラムは以下の環境での動作を確認しています. =end JA =begin EN == Operation Environment This program is operated by following environments. =end EN =begin * ((<"Debian GNU/Linux 3.1"|URL:http://www.debian.org/ >)) + (()) * ((<"Debian GNU/Linux 3.1 "|URL:http://www.debian.org/ >)) + (()) * ((<"Debian GNU/Linux 3.1 "|URL:http://www.debian.org/ >)) + (()) * ((<"Debian GNU/Linux 3.0, 3.1"|URL:http://www.debian.org/ >)) + (()) * NEC SX-6 + FORTRAN90/SX =end =begin JA == 入出力ファイル形式 gt4f90io は以下のファイル形式をサポートします. * (()) に従う netCDF ファイル また, 今後以下のファイル形式がサポートされるといいなと考えています. * GrADS 格子点データ * GRIB * その他一般のべた書き系データ =end JA =begin EN == Input Output Data Format gt4f90io support following data format. * NetCDF file conformed with (()) =end EN =begin JA == コンパイルに必要なライブラリ gt4f90io を利用するためには, 以下のソフトウェアを 事前にインストールしておく必要があります. : (()) (バージョン 3.5.0, 3.6.0) debian を使用していてインストールパッケージを利用する場合 * deb パッケージ [(()) | (())] 上記 deb パッケージの他に netCDF の Development kit もインストールする 必要があります (netcdfg-dev パッケージ). ソースからコンパイルする場合 * ((<3.6.0 版 ソースのTGZ|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/netcdf-3.6.0-p1.tar.gz>)) [(()) | ((<(日本語訳)|URL:INSTALL_netcdf.htm>)) ] [(())] ドキュメントを生成するためには以下のソフトウェアを 事前にインストールしておく必要があります. ただし, (()) から入手する場合には既に生成済みです. * (()) * (()) * ((<"RDOC Fortran90/95 ソースコード解析機能強化版"|URL:http://www.gfd-dennou.org/library/dcmodel>)) #* (()) =end JA =begin EN == Libraries needed for compile To use gt4f90io, following softwares should be installed. * (()) (version 3.5.0 or 3.6.0) * (()), deb package [(()) | (())] * Installation Guide * [(())] * [(())] If you use above Debian package to install netCDF, you need ((* "netcdfg-dev" *)) package too. (Parhaps you can get by "apt-get"). Following softwares should be installed for generating documentations. But, if you get from (()), documentations are already generated. * (()) * (()) * ((<"Enhanced version of RDOC Fortran90/95 parser"|URL:http://www.gfd-dennou.org/library/dcmodel>)) #* (()) =end EN =begin JA == コンパイルの手引き =end JA =begin EN == Compile source code =end EN =begin JA === TGZ パッケージの展開 適当な作業ディレクトリでソースアーカイブを展開します. ソースは gt4f90io-((|バージョン|)) というディレクトリに展開されます. $ tar xvzf gt4f90io-current.tgz =end JA =begin EN === Extract TGZ Package Make an empty directory, and extract archive. A directory `gt4f90io-((|version|))' created at the current working directory. $ tar xvzf gt4f90io-current.tgz =end EN =begin JA === Fortran コンパイラの指定 環境変数 ((* FC *)) に使用する Fortran コンパイラを指定してください. 以下は, 利用するコンパイラが frt の場合です. * sh, bash の場合 $ export FC=frt * csh, tcsh の場合 $ setenv FC frt 最適化やデバッグのためのオプションは環境変数 ((* FFLAGS *)) に設定してください. 以下は frt の高速化と 並列化のためのオプションです. * sh, bash の場合 $ export FFLAGS="-Kfast,parallel" * csh, tcsh の場合 $ setenv FFLAGS "-Kfast,parallel" =end JA =begin EN === Specify Fortran Compiler Specify Fortran compiler to environmental variable ((* FC *)). For example, if you use "frt", * sh, bash $ export FC=frt * 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 $ export FFLAGS="-Kfast,parallel" * csh, tcsh $ setenv FFLAGS "-Kfast,parallel" =end EN =begin JA === Config.mk の作成 展開されたディレクトリに移動し, (({ ./configure }))を実行します. (({ --with-netcdf= })) には netcdf ライブラリのパスを指定します. (以下の例は /usr/local/netcdf/lib/libnetcdf.a にライブラリがある 場合のものです). このコマンドによって (({ Config.mk })) ファイルが生成されます. $ ./configure --with-netcdf=/usr/local/netcdf/lib/libnetcdf.a (({ Config.mk })) ファイルが生成されると同時に, (({config.cache})) ファイルが作成され, オプションの情報が保持されます. 自動的に (({config.cache})) が読み込まれるため, 再度 (({ ./configure })) する際は前回のオプションが引き継がれます. もしも前回以前のオプション設定を 破棄したい場合には以下のコマンドを用いてください. $ make distclean Debian GNU/Linux で Fujitsu Fortran を利用している場合には, Config.cache.debian-ffc* を (({config.cache})) に移動して (({ ./configure })) コマンドを実行するだけで自動的に ライブラリの位置が設定されます. $ cp Config.cache.debian-ffc5 config.cache $ ./configure なお, インストール先やコンパイルのオプションを変更したい場合は, 以下のように (({ --help })) オプションをつけることで, 指定可能なオプションリストが表示されます. $ ./configure --help 主なオプションに関しての説明です. :(({--with-netcdf=}))((|ARG|)) ((|ARG|)) に ((<コンパイルに必要なライブラリ>)) の netCDF ライブラリを指定します. 必ず明示的に指定する必要があります. :(({--prefix=}))((|ARG|)) ((|ARG|)) にライブラリやモジュール, 実行ファイルのインストール先の ディレクトリのプレフィックスを指定します. デフォルトは (({ /usr/local/gt4f90io })) です. :(({--libdir=}))((|ARG|)) ((|ARG|)) にライブラリのインストール先のディレクトリを指定します. デフォルトは (({ /usr/local/gt4f90io/lib })) です. :(({--includedir=}))((|ARG|)) ((|ARG|)) にモジュール情報ファイルのインストール先のディレクトリ を指定します. デフォルトは (({ /usr/local/gt4f90io/include })) です. :(({--bindir=}))((|ARG|)) ((|ARG|)) に実行ファイルのインストール先のディレクトリを指定します. デフォルトは (({ /usr/local/gt4f90io/bin })) です. :(({--with-docdir=}))((|ARG|)) ((|ARG|)) にドキュメントファイルのインストール先を指定します. デフォルトは (({ /usr/local/gt4f90io/doc })) です. :(({--with-fc=}))((|ARG|)) Fortran コンパイラを指定します. 環境変数 $FC よりも優先されます. (({config.cache})) に設定されたものを上書きする際に利用してください. (一度 (({config.cache})) に Fortran コンパイラが指定されると, 環境変数 $FC は無視されます). :(({--with-fflags=}))((|ARG|)) Fortran のデバッグや最適化のオプションを指定します. 環境変数 $FFLAGS が指定される場合, このオプションで 与えられるものも含め, 全てコンパイル時のオプションとして指定されます. (重複に注意してください). :(({--with-gt4libname=}))((|ARG|)) ((|ARG|)) に gt4f90io のライブラリ名を指定します. ライブラリ名は (({lib}))((||))(({.a})) となります. デフォルトは (({ gt4f90io })) であり, その際のライブラリ名は (({ libgt4f90io.a })) となります. :(({--with-gt4suffix=}))((|ARG|)) ((|ARG|)) にはインストールディレクトリ, ライブラリ名, 実行ファイルの末尾につける接尾語を指定します. 例えば, 他が全てデフォルトの設定で (({ ffc5 })) と指定すると, インストール先のディレクトリのプレフィックスが (({ /usr/local/gt4f90io-ffc5 })), ライブラリ名が (({ libgt4f90io-ffc5.a })), インストールする実行ファイル名は (({ gt4frt.ffc5 })), (({ gt4config.ffc5 })) 等のように なります. :(({--with-lang_conform_check=}))((|ARG|)) ((|ARG|)) に言語規格を指定することで, コンパイル時に言語規格の チェックを行うよう, オプションを追加します. 現在 "(({95}))" のみ指定可能です. コンパイラによっては指定できません. :(({--enable-debug})) このオプションを指定することで, コンパイル時や実行時にデバッグメッセージ を出力するオプションを追加します. コンパイラによっては指定できません. :(({--with-abort=}))((|ARG|)) ((|ARG|)) に (({abort, errtra-setrcd, exit, setrcd, stop})) のいずれか を指定することで, 終了時に用いる Fortran の内部関数を変更することが 可能です. デフォルトは (({ abort })) です. : abort Fortran の内部サブルーチン abort で終了します. : errtra-setrcd Fujitsu Fortran の ERRTRA サービスサブルーチンを呼び出し, 現在実行中のプログラム単位までのトレースバックマップを出力し, 終了します. Fujitsu Fortran の SETRCD サービスサブルーチンにて, 復帰コード 13 を設定し, 終了コードとして 3 を設定します. : exit Fortran の内部サブルーチン exit で終了します. : setrcd Fujitsu Fortran の SETRCD サービスサブルーチンを呼び出し, Fortran の復帰コードとして 3 を設定して終了します. : stop Fortran の内部関数 stop で終了します. =end JA =begin EN === Create `Config.mk' Move created directroy, and excute `(({ ./configure }))'. If your path of netCDF library is `/usr/local/netcdf/lib/libnetcdf.a', you should set options as follow. A configure file `Config.mk' created at the current working directory. $ ./configure --with-netcdf=/usr/local/netcdf/lib/libnetcdf.a (({config.cache})) is also created with (({ Config.mk })). This file stores arguments of options. When you execute (({ ./configure })) again, (({config.cache})) is loaded automatically. If you nullify previous settings, do following command. $ make distclean 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 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. :(({--with-netcdf=}))((|ARG|)) Specify netCDF library in (()) to ((|ARG|)). You must specify explicitly. :(({--prefix=}))((|ARG|)) Specify prefix to ((|ARG|)). Default value is (({ /usr/local/gt4f90io })). :(({--libdir=}))((|ARG|)) Specify directory to which the library is installed to ((|ARG|)). Default value is (({ /usr/local/gt4f90io/lib })). :(({--includedir=}))((|ARG|)) Specify directory to which the module is installed to ((|ARG|)). Default value is (({ /usr/local/gt4f90io/include })). :(({--bindir=}))((|ARG|)) Specify directory to which the executable file is installed to ((|ARG|)). Default value is (({ /usr/local/gt4f90io/bin })). :(({--with-docdir=}))((|ARG|)) Specify directory to which the documentation file is installed to ((|ARG|)). Default value is (({ /usr/local/gt4f90io/doc })). :(({--with-fc=}))((|ARG|)) Specify Fortran compiler. This option have priority over shell variable "$FC". Use when you want to override (({config.cache})). (Once (({config.cache})) is created, shell variable "$FC" is ignored). :(({--with-fflags=}))((|ARG|)) Specify options for debug and optimization. Shell variables "$FFLAGC" and "$FCFLAGS" are used too when compiled and linked. :(({--with-gt4libname=}))((|ARG|)) Specify gt4f90io library name to ((|ARG|)). Library name becomes (({lib}))((||))(({.a})) . Default value is (({ gt4f90io })), so library name becomes (({ libgt4f90io.a })) . :(({--with-gt4suffix=}))((|ARG|)) Specify suffix of installdir, library name, executable files to((|ARG|)). For example, you specify (({ ffc5 })) when others are default, prefix of installdir becomes (({ /usr/local/gt4f90io-ffc5 })), library name becomes (({ libgt4f90io-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. :(({--with-abort=}))((|ARG|)) Specify one of (({abort, errtra-setrcd, exit, setrcd, stop})) to ((|ARG|)). Default value is (({ abort })). : abort Stop by intrinsic subroutine "abort". : errtra-setrcd Stop by Fujitsu Fortran service subroutine "ERRTRA". And outputs error trace back map. : exit Stop by intrinsic subroutine "exit". : setrcd Stop by Fujitsu Fortran service subroutine "SETRCD". And outputs error trace back map. : stop Stop by intrinsic subroutine "stop". =end EN =begin JA === Config.mk の編集 環境に合わせ (({ Config.mk })) を手動で編集してください. FC : Fortran コンパイラ SYSFFLAGS : コンパイル時・リンク時に必要なフラグ (Fortran コンパイラ実行時に必要なオプション) SYSLDFLAGS : リンク時に必要なフラグ SYSLDLIBS : リンク時に必要なライブラリ F90MODTYPE : モジュール情報の渡し方 DEST_LIB : gt4f90io ライブラリインストールディレクトリ DEST_INC : gt4f90io モジュールインストールディレクトリ DEST_BIN : gt4f90io 実行ファイルインストールディレクトリ DEST_DOC : gt4f90io ドキュメントファイルインストールディレクトリ MODS : モジュールファイル拡張子 AR : アーカイブコマンド =end JA =begin EN === Edit `Config.mk' Edit `(({Config.mk}))' manually, if you want to change. FC : Fortran Compiler SYSFFLAGS : Flags needed when compiled and linked SYSLDFLAGS : Flags needed when linked SYSLDLIBS : Libraries needed when linked F90MODTYPE : Information of Modules (std.mod, HP.mod, fqs.mod, intel.d, hitachi.f90) DEST_LIB : Directory to which the library file is installed DEST_INC : directory to which the module files are installed DEST_BIN : directory to which the executable files are installed DEST_DOC : directory to which the documantation files are installed MODS : Extensions of Module Files used when "make clean" AR : Archive command =end EN =begin JA === ソースコードのコンパイル カレントディレクトリで以下のコマンドを実行してください. $ make =end JA =begin EN === Compile source code In current directory, execute following command. $ make =end EN =begin JA === ドキュメントの生成 マニュアルとコードリファレンスのコンパイルはカレントディレクトリ において, 以下のコマンドを実行してください. (()) から入手する場合には既に生成済みです. $ make doc =end JA =begin EN === Generate documentations To generate documentations, execute following command in current directory. If you get from (()), documentations are already generated. $ make doc =end EN =begin JA == インストールの手引き カレントディレクトリで以下のコマンドを実行してください. システム領域にインストールする場合には管理者権限が 必要です. (デフォルトの場合はシステム領域にインストールします). # make install ドキュメントをインストールする場合には以下のコマンドを実行します. # make install-doc =end JA =begin EN == Install Procedure In current directory, execute following command. If you install to system, you need to be administrator. (By default, you install to system). # make install If you want to install documentation files, execute following command. # make install-doc =end EN =begin JA == テストプログラム実行の手順 カレントディレクトリにおいて, 以下のコマンドを実行してください. エラーが生じずに "(({ *** Compilation and installation are succeeded !! *** }))" というメッセージが表示されればインストールは完了です. $ make test-installed =end JA =begin EN == Execute test programs In current directry, execute following command. If message "(({ *** Compilation and installation are succeeded !! *** }))" are showed without error, installation is completed. $ make test-installed =end EN =begin JA == ((*gt4frt*)) へのパスの設定 上記のように正しくインストールが行われたら, ((*gt4frt*)) というシェルスクリプトが (({--prefix=}))((|ARG|)) で指定されたディレクトリ以下の bin ディレクトリ ((|ARG|))/bin に作成されているはずです. ( (({--prefix=})) を指定しなかった場合は (({ /usr/local/gt4f90io/bin/ })) 以下). このディレクトリへのパスを通してください. 以下は (({ /usr/local/gt4f90io/bin/ })) 以下に ((*gt4frt*)) がインストールされた場合の例です. * sh, bash $ export PATH=$PATH:/usr/local/gt4f90io/bin * csh, tcsh $ setenv PATH $PATH:/usr/local/gt4f90io/bin ((*gt4frt*)) は Fortran コンパイラのラッパーのようなコマンドで, 自動的に gt4f90io ライブラリへリンクをはってコンパイルを行って くれます. $ gt4frt test.f90 /usr/bin/frt -I/usr/lib/gtool4-ffc4/include -w -Am test.f90 \ -L/usr/lib/gtool4-ffc4/lib -lgtool4 -L/usr/lib -lnetcdf-ffc4 =end JA =begin EN == Path to ((*gt4frt*)) If the installation is correctly done as stated above, shell script ((*gt4frt*)) is made under the directory (({--prefix=}))((|ARG|))/bin (By default, (({ /usr/local/gt4f90io/bin/ })) ). Please specify PATH to this directory. It is an example as follows when ((*gt4frt*)) is installed in (({/usr/local/gt4f90io/bin/})) . * sh, bash $ export PATH=$PATH:/usr/local/gt4f90io/bin * csh, tcsh $ setenv PATH $PATH:/usr/local/gt4f90io/bin ((*gt4frt*)) is a command like the rapper of the Fortran compiler. This command compiles Fortran files automatically linking with the gt4f90io library. $ gt4frt test.f90 /usr/bin/frt -I/usr/lib/gtool4-ffc4/include -w -Am test.f90 \ -L/usr/lib/gtool4-ffc4/lib -lgtool4 -L/usr/lib -lnetcdf-ffc4 =end EN =begin HTML
$Id: INSTALL,v 1.8 2006/01/17 11:21:57 morikawa Exp $ =end HTML #== Mode setting for Emacs #Local Variables: #mode: rd #End: #