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