#= INSTALL guide of deepconv/arare
#
# Authors:: SUGIYAMA Ko-ichiro, ODAKA Masatsugu
# Version:: $Id: INSTALL,v 1.4 2011-12-06 07:11:07 odakker Exp $
# Tag Name: $Name: arare5-20120828 $
# Copyright:: Copyright (C) GFD Dennou Club, 2006. All rights reserved.
# License:: See COPYRIGHT[link:COPYRIGHT]
#
########################################################################
#
=begin JA

= deepconv/arare 󥹥ȡ

#*  ̰ϯ,  ,  ã
#  * 2011/12/06  () ǽ
#  * 2011/08/09  () ǽ
#  * 2011/06/14  (̰ϯ) ǽ
#  * 2011/03/02  ( ã) ǽ
#  * 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
#  * 2011/12/06  (Masatsugu Odaka) Update
#  * 2011/08/09  (Masatsugu Odaka) Update
#  * 2011/06/14  (Ko-ichiro Sugiyama) Update
#  * 2011/03/02  (Tatsuya Yamashita) Update
#  * 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) ((<Supported system>))
(2) ((<Required softwares>))
(3) ((<Installation>))
(4) ((<Major files and directories in source tree>))


=end EN

=begin JA

== ưĶ

2011 ǯ 06  14 , ʲδĶǤưǧƤޤ.

=== Linux on x86

 * Debian GNU/Linux 6.0 (squuze) + gfortran + LAPACK 

 * Debian GNU/Linux 5.0 (lenny) + PGI compiler + LAPACK + mpich2

 * Debian GNU/Linux 5.0 (lenny) + g95 + LAPACK + mpich2

 * Debian GNU/Linux 5.0 (lenny) + ifort (ver.11.0) + lapack + mpich2

 * Debian GNU/Linux 5.0 (lenny) + 
   ((<FQS Fortran90|URL:http://software.fujitsu.com/jp/fortranc/>)) (64 ver.1) 
   + 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 6.0 (squuze) + gfortran + LAPACK 

 * Debian GNU/Linux 5.0 (lenny) + PGI compiler + LAPACK + mpich2

 * Debian GNU/Linux 5.0 (lenny) + g95 + LAPACK + mpich2

 * Debian GNU/Linux 5.0 (lenny) + ifort (ver.11.0) + lapack + mpich2

 * Debian GNU/Linux 5.0 (lenny) + 
   ((<FQS Fortran90|URL:http://software.fujitsu.com/jp/fortranc/>)) (64 ver.1) 
   + 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 򥤥󥹥ȡȼ¹ԤˤϰʲΥեȥ˥󥹥ȡ
Ƥɬפޤ. 


: ((<netCDF|URL:http://www.unidata.ucar.edu/software/netcdf/>)) (С 3.6.x)

  饳ѥ뤹
  * ((< TGZ|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/>))

    [((<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>))]

    [((<Unidata ܲȤΥ󥹥ȡ륬ɤܼ|URL:http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/index.html>))]
  
: ((<gtool5 饤֥|URL:http://www.gfd-dennou.org/library/gtool/>))

  饳ѥ뤹
  * ((<gtool5 TGZ|URL:http://www.gfd-dennou.org/library/gtool/gtool5/gtool5_current.tgz>))
    [((<󥹥ȡ륬ɤܼ|URL:http://www.gfd-dennou.org/library/gtool/gtool5/gtool5_current/INSTALL.htm>))]

: LAPACK/BLAS

  饳ѥ뤹
  * ((<LAPACK  TGZ|URL:http://www.netlib.org/lapack/>)) 
  * ((<BLAS  TGZ|URL:http://www.netlib.org/blas/>)) 


== ɥȤΥѥɬפʥեȥ

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/>)) 
  * rd2 ѥѥåե ((<"http://www.gfd-dennou.org/library/dcmodel/doc/rd2-filter.patch"|URL:http://www.gfd-dennou.org/library/dcmodel/doc/rd2-filter.patch>))

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

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

    [((<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>))]

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

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

: 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/>)) 


== 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/>)) 
  * rd2 patch file ((<"http://www.gfd-dennou.org/library/dcmodel/doc/rd2-filter.patch"|URL:http://www.gfd-dennou.org/library/dcmodel/doc/rd2-filter.patch>))

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
== 󥹥ȡμ

=== 

wget ʤɤǥ

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

=== tgz եŸ, ǥ쥯ȥؤΰư

  $ tar -xzvf arare5_current.tgz
  $ cd arare5-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 ǥѥ뤷Ƥ.


 Mkinclude γƥޥǧ, 󥹥ȡδĶˤ碌
ŬԽ. 

  mpi Ѥ, CPPFLAGS=LIB_MPI Ȥ뤳. 



=== Υѥ

ѥ GNU make ѤƹԤ. 
	
==== 2 ׻Ԥʤ

ĥ꡼ľ

        $ make

¹ԤȥľΰʲΥǥ쥯ȥ˼¹ԥեȥ饤֥,
⥸塼ե뤬Ÿ.

	./lib		饤֥ libarare.a Ǽ
	./bin		¹ԥե뤬Ǽ
	./include	Ƽ *.mod ե뤬Ǽ

bin ʲˤϼμ¹ԥե뤬Ǽ.

	arare           3 ήǥ
	arare_init-data ͥեѼ¹ԥե


=== ɥȤΥѥ

==== 󥹥ȡμ, Ѥμȥɥե

	$ make doc  


=end JA
=begin EN

== Installation 

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

=== 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 use MPI, please edit Mkinclude; 

  CPPFLAGS = LIB_MPI


=== 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  

=end EN

=begin JA
== 󥤥󥹥ȡμ

src ǥ쥯ȥʲΥ֥ȥե, ¹ԥեξõ

	$ make clean

Ȥ.

ǥΥǥ, 󥹥ȡμ, 
Ѥμȥɥե󥹤ξõ

	$ make clean.doc

Ȥ. 

	$ 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

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

	$ make clean.all

=end EN

=begin JA
== ĥ꡼ʲμפʥեȥǥ쥯ȥ

   COPYRIGHT	 饤
   INSTALL	 󥹥ȡ
   Makefile	 Makefile
   Mkinclude	 Makefile  include ե (configure )

   bin/		 ¹ԥեǼǥ쥯ȥ (ѥ˺)
   css/		 륷ȳǼǥ쥯ȥ
   doc/		 ɥȳǼǥ쥯ȥ
      dai1bu/	 ǥǼǥ쥯ȥ
      dai2bu/	 ΥǥǼǥ쥯ȥ
      code_reference/	 ɥե󥹳Ǽǥ쥯ȥ
      tutorial/	 	 塼ȥꥢ
   include/	 ⥸塼Ǽǥ쥯ȥ (ѥ˺)
   lib/		 饤֥Ǽǥ쥯ȥ (ѥ˺)
   src/		 ɳǼǥ쥯ȥ
       Makefile  Makefile
       chemdat/  ؼλꤪʪͤȷ׻
       dynamics/ ϳز
       env/      ܾȾν
       io/       
       main/     ץ, , ̤η׻
       physics/  ʪ
       setup/    
       util/     ʿʬ黻, ׻벼׻
       sample_nml/ եΥץ
   scripts/	Ϥ䳨Τ˻Ȥġ뷲

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

   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
       dynamics/ Dynamical process
       env/      Setup for initial condition
       io/       Input/Output
       main/     Main program
       physics/  Physical processes
       setup/    Initial setup
       util/     Low level routines
       sample_nml sample of namelist file
   scripts/	 Tools for drawing figure and analysis


=end EN

