wrfv2_fire/chem/KPP/kpp/kpp-2.1/readme

   1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   2
   3   KPP - symbolic chemistry Kinetics PreProcessor, Version 2.1
   4         (http://www.cs.vt.edu/~asandu/Software/KPP)
   5   KPP is distributed under GPL, the general public licence
   6         (http://www.gnu.org/copyleft/gpl.html)
   7     (C) 1995-1997, V. Damian & A. Sandu, CGRER, Univ. Iowa
   8     (C) 1997-2003, A. Sandu, Michigan Tech
   9     (C) 2003-2005, A. Sandu, Virginia Polytechnic Institute and State University
  10         with contributions from:
  11         R. Sander, Max-Planck Institute for Chemistry, Mainz, Germany
  12
  13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14
  15 To get started with KPP:  Read user's manual (doc/kpp-UserManual.pdf)
  16 ------------------------
  17
  18 To install KPP:
  19 ---------------
  20
  21 1. Make sure that FLEX (public domain lexical analizer) is installed
  22    on your machine. Type "flex --version" to test this.
  23
  24 2. Note down the exact path name where the FLEX library is installed. The
  25    library is called:
  26         libfl.a or libfl.sh
  27
  28 3. Define the KPP_HOME environment variable to point to the complete
  29    path location of KPP. If, for example, KPP is installed in $HOME/kpp:
  30
  31    - with C shell (or tcsh) edit the file .cshrc (or .tcshrc) in your
  32      home directory and add:
  33         setenv KPP_HOME $HOME/kpp
  34         set path=( $path $HOME/kpp/bin )
  35      Execute 'source .cshrc' (or 'source .tcshrc') to make sure these
  36      changes are in effect.
  37
  38    - with bash shell edit the file .bashrc in your home directory and add:
  39         export KPP_HOME=$HOME/kpp
  40         export PATH=$PATH:$HOME/kpp/bin
  41
  42 3. In KPP_HOME directory edit:
  43         Makefile.defs
  44    and follow the instructions included to specify the compiler,
  45    the location of the FLEX library, etc.
  46
  47 4. In KPP_HOME directory build the sources using:
  48         make
  49
  50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  51
  52 To clean the KPP installation:
  53 ------------------------------
  54
  55 1. Delete the KPP object files with:
  56         make clean
  57
  58 2. Delete the whole distribution (including the KPP binaries) with:
  59         make distclean
  60
  61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62
  63 If you have any problems please send the detailed error report and the machine
  64 environment to:
  65
  66         sandu@cs.vt.edu