#= INSTALL guide of deepconv/arare
#
# Authors:: SUGIYAMA Ko-ichiro, ODAKA Masatsugu
# Version:: $Id: INSTALL,v 1.7 2006/11/09 09:29:58 odakker Exp $
# Tag Name: $Name: arare4-20061224 $
# Copyright:: Copyright (C) GFD Dennou Club, 2006. All rights reserved.
# License:: See COPYRIGHT[link:COPYRIGHT]
#
########################################################################
#
=begin TOPLINK
[((<English|URL:INSTALL.htm.en>)) |
((<Japanese|URL:INSTALL.htm>))]
[((<GFD Dennou Club|URL:http://www.gfd-dennou.org>)) |
((<deepconv Project|URL:http://www.gfd-dennou.org/library/deepconv>))]
[((<deepconv Reference Manual|URL:doc/index.htm>))]
=end TOPLINK

=begin JA

= deepconv/arare 󥹥ȡ

*  ̰ϯ,  
  * 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  ( ) 
=end JA

=begin EN

= Deepconv/arare installation guide

* Ko-ichiro Sugiyama, Masatsugu Odaka
  * 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
=end EN

=begin JA
== μ

ɤ ((<"http://www.gfd-dennou.org/library/deepconv/arare/"|URL:http://www.gfd-dennou.org/library/deepconv/arare/>)) ɤǤ. 


=end JA
=begin EN
== Download of source code

The source code of deepconv can be downloaded from 
((<"http://www.gfd-dennou.org/library/deepconv/arare/"|URL:http://www.gfd-dennou.org/library/deepconv/arare/>)).

=end EN

=begin JA
== ưĶ

߰ʲδĶǤưǧƤ.

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


=== 緿׻

 * Ω SR11000 + ΩŬ Fortran + LAPACK/MATRIX
 * NEC SX6 + sxf90

=end JA
=begin EN
== Supported system

Deepconv can be compiled and run on following platforms (2006-10-30).

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


=== Super Computer System 

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

=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 Fujitsu F90 compiler on Linux
       Mkinclude.g95  for g95

   tools/	 Tools for draw figure and analysis


=end EN

==begin JA
== ѥɬפʥեȥ

deepconv/arare 򥤥󥹥ȡȼ¹ԤˤϰʲΥեȥ˥󥹥ȡ
Ƥɬפ. 


: netCDF (С 3.5.0, 3.6.0, 3.6.1)

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

    [((<Unidata ܲ NetCDFå󥹥ȡ륬 (Ѹ) |URL:http://my.unidata.ucar.edu/content/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://my.unidata.ucar.edu/content/software/netcdf/docs/netcdf-install/index.html>))]
  
  Debian GNU/Linux ѤƤ, netCDF ХʥѥåѤ
  
  * debian ѥå
    [((<Fujitsu ver5|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/netcdf-ffc5_3.6.0-2_i386.deb>)) |
    ((<Intel ver8.1|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/netcdf-ifc8.1_3.6.0-p1-1_i386.deb>)) |
    ((<g95|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf-g95/sarge/>))]

    嵭 deb ѥå¾ netCDF  Development kit ⥤󥹥ȡ뤹
    ɬפޤ (netcdfg-dev ѥå).


: gt4f90io 饤֥

  饳ѥ뤹
  * ((<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 ѤƤ, gt4f90io ХʥѥåѤ
  ((<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 ѤƤ, gt4f90io ХʥѥåѤ
  ((<URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/>))
  ˤۤƤХʥѥåѤǤޤ.


== ɥȤΥѥɬפʥեȥ

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 (version 3.5.0, 3.6.0, 3.6.1)

  ((<TGZ file of netCDF|URL:http://www.gfd-dennou.org/library/netcdf/unidata-mirror/netcdf-3.6.0-p1.tar.gz>))

  [((<NetCDF quick installation guide|URL:http://my.unidata.ucar.edu/content/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://my.unidata.ucar.edu/content/software/netcdf/docs/netcdf-install/index.html>))]
  
  For Debian GNU/Linux users
  * debian packages
    [((<Fujitsu ver5|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/netcdf-ffc5_3.6.0-2_i386.deb>)) |
    ((<Intel ver8.1|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf/sarge/netcdf-ifc8.1_3.6.0-p1-1_i386.deb>)) |
    ((<g95|URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/netcdf-g95/sarge/>))]

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


: gt4f90io 

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

  Binary package of Debian GNU/Linux can be downloaded from
  ((<URL:http://www.gfd-dennou.org/library/gtool4/debian.htm>)).


: LAPACK/BLAS

  ((<TGZ file of LAPACK|URL:http://www.netlib.org/lapack/>)) 

  ((<TGZ file of BLAS |URL:http://www.netlib.org/blas/>)) 

  Binary package of Debian GNU/Linux can be downloaded from
  ((<URL:http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou/>)).


== Required softwares to build documentation 

* 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/>))
  * ((<"RDOC Fortran90/95 ɲϵǽ"|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-BLASk=(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-anal	̲ϥޥ
	randomset	ꥳޥ


=== ɥȤΥѥ

󥹥ȡμ, Ѥμȥɥե󥹤Υѥ

	$ 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