README.txt

   1 This is the coupled WRF-Fire model, combining WRF and the SFIRE codes.
   2
   3 For terms and conditions see the file license.txt
   4
   5 Documentation is in progress. Current drafts of the technical documentation and
   6 user's guide can be found at
   7
   8 http://math.ucdenver.edu/~jmandel/fires/wrf-fire-doc.pdf
   9 http://math.ucdenver.edu/~jmandel/fires/wrf-fire-guide.pdf
  10
  11 If you find this code useful please acknowledge our work by citing the paper
  12 [1].  Yes this is a strange reference for an atmospheric scientist but it
  13 is the only one we have at the moment. Please see the sections
  14 "Fireline propagation model", "Coupling ﬁre and weather models", and
  15 "Level-set-based wildland fire model".  The fire model is based on [2]
  16 but not all features from [2] are implemented here yet.
  17
  18 We hope you find the code useful. Please let us know if we can help. But
  19 do us a favor and before you ask a question (such as, what is git?)
  20 please google first. You may need to find a local guru for Linux questions.
  21 Thank you!
  22
  23 Janice Coen - physics
  24 Jan Mandel - the fire code
  25 Jonathan Beezley - WRF infrastructure and WPS
  26
  27 [1] Jan Mandel, Jonathan D. Beezley, Janice L. Coen, Minjeong Kim, Data
  28 Assimilation for Wildland Fires: Ensemble Kalman filters in coupled
  29 atmosphere-surface models, IEEE Control Systems Magazine, 2009,
  30 29, Issue 3, June 2009, 47-65. http://dx.doi.org/10.1109/MCS.2009.932224
  31 Preprint available from http://arxiv.org/abs/0712.3965
  32
  33 [2] J. L. Coen, “Simulation of the Big Elk Fire using using coupled
  34 atmosphere-fire modeling,” International Journal of Wildland Fire, vol. 14,
  35 no. 1, pp. 49–59, 2005
  36
  37 --------------------------------------------------------------------
  38
  39 SUPPORT
  40
  41 For support please subscribe to the wrf-fire mailing list at NCAR at
  42 http://mailman.ucar.edu/mailman/listinfo/wrf-fire
  43 or see http://www.openwfm.org/wiki/index.php5/Talk:WRF-Fire
  44
  45 You can also ask directly Jan.Mandel@gmail.com
  46
  47 Answers to any questions may be copied or summarized to the wrf-fire list
  48 and/or the wiki.
  49
  50
  51 COMPILERS
  52
  53 Tested on linux/ifort/gcc, linux/pgi, linux/g95 (all x86-64), and mac/g95.
  54 Mac will not run optimized or real data, though. ifort for Linux can be
  55 downloaded from Intel free for non-commercial use. gfortran is not included
  56 because gfortran currently cannot compile wrf.
  57
  58
  59 SETUP
  60
  61 We strongly recommend using git not a tar file to download the code
  62 so that you can get updates easily and also keep your changes.
  63 You will probably need to install git.  A current version (now 1.6)
  64 recommended. You may need to install git from sources.
  65
  66 Download NETCDF and install. The curent version is 4.0 Some hints:
  67 Set the environment variables CC FC and F90 to your compilers.
  68 Set the install location by something like
  69 ./configure --prefix=/opt/netcdf
  70 (Of course, use your own location)
  71 Set the environment variable to the top level netcdf directory like:
  72 setenv NETCDF /opt/netcdf
  73 (Of course, replace the path by your location of NETCDF above)
  74
  75 Local developers can source env.csh with setup for some local machines where
  76 NETCDF is already installed.
  77
  78
  79 DOWNLOAD SITES
  80
  81 The code can be downloaded from http://github.com/jbeezley/wrf-fire/ by
  82
  83          git clone git://github.com/jbeezley/wrf-fire.git
  84
  85 You can see current activities, branches, and download the code also from
  86
  87          http://repo.or.cz/git-browser/by-commit.html?r=wrffire.git
  88
  89 Developers with write access get the code and submit changes by
  90
  91          git clone ssh://user@math.ucdenver.edu/home/grads/jbeezley/wrf-fire.git
  92
  93 where "user" is your username at math.ucdenver.edu.
  94
  95
  96 BRANCHES
  97
  98 Use the code from the master branch as it is the only stable one. Use other
  99 branches only if instructed by the developers. We recommend to set up your own
 100 branch for your changes and merge master into it when it is updated.
 101 See doc/README_git.txt
 102
 103
 104 BUILDING
 105
 106
 107 cd wrfv2_fire
 108 ./configure # select an option for your computer architecture/compilers
 109             # If you are trying to get this working on different
 110             # compilers, try copying a section close to your case
 111             # in arch/configure_new.defaults to the end of that file
 112             # and modifying to suit your needs... good luck.
 113 ./compile em_fire >& compile.log
 114
 115 This will take a while.  Make sure that compile.log contains
 116 no errors.  ("grep Error compile.log" shouldn't return anything).
 117
 118
 119 RUNNING
 120
 121 cd test/em_fire/small
 122 ./ideal.exe >& ideal.log (this creates file wrfinput_d01, needs to be done only
 123 when input_sounding changes)
 124 ./wrf.exe
 125
 126 This runs an "idealized" problem.
 127 For RUNNING ON REAL DATA see doc/README_wps.txt
 128
 129
 130 STANDALONE FIRE MODEL TEST
 131
 132 With ifort:
 133
 134 cd phys
 135 ./ifmake clean
 136 ./ifmake model_test
 137
 138 Without the clean between different kind of builds nothing will work.
 139 There is g95make for g95.
 140 With other compilers, try someting like
 141
 142     make -f testmakefile FC=your fortran compiler
 143
 144 See wrfv2_fire/phys/README_jm.txt for more info.
 145
 146 NOTE: maintaining the standalone model is low priority and it may not work.
 147
 148
 149 ADDITIONAL DOCUMENTATION IN THE doc SUBDIRECTORY
 150
 151
 152 README.txt                  this file, how to compile and run WRF/SFIRE on ideal data
 153 README_git.txt              how to use the versioning system
 154 README_mac.txt              how to run on a Mac
 155 README_matlab_netcdf.txt    how to read WRF input and output directly in Matlab
 156 README_vis.txt              matlab visualization using files written every timestep
 157 README_visualization.txt    convert WRF input and output to Matlab
 158 README_wps.txt              how use real data including fuel from Landfire
 159