adding subset_domain.m
[wrffire.git] / README.txt
blobad1297d72593374b49ad996280da5f5c3c0b3762
1 ! SFIRE - Spread fire model in WRF-Fire
3 !*** Jan Mandel August 2007 - March 2011 
4 !*** email: Jan.Mandel@gmail.com
6 ! For support please go to 
7 ! http://www.openwfm.org/wiki/WRF-Fire_user_support 
9 ! Current user's guide can be found at
10 ! http://www.openwfm.org/wiki/Users_guide 
12 ! For reference publications see
13 ! http://www.openwfm.org/wiki/WRF-Fire_publications
15 ! A limited version from 2010 is included in WRF release. We no longer 
16 ! support that version.
18 ! This module is the only entry point from WRF-ARW to the wildland 
19 ! fire model. The call to sfire_driver advances the fire model by 
20 ! one timestep. The fire model inputs the wind and outputs 
21 ! temperature and humidity tendencies. The fire model also inputs a 
22 ! number of constant arrays (fuel data, topography). Additional 
23 ! arguments are model state (for data assimilation) and constant arrays 
24 ! the model gives to WRF for safekeeping because it is not allowed 
25 ! to save anything.
27 ! This code as of mid-2011 is described in [1]. If you use this code, 
28 ! please acknowledge our work by citing [1].
29 ! Thank you.
31 ! Acknowledgements
33 ! The fire physics code is adapted from the CAWFE code [2].
34 ! The coupling with WRF is adapted from a code by Ned Patton, 
35 ! coupling a Fortran 90 port of the CAWFE fire module to WRF [3].
36 ! Support of refined fire grids in WRF was provided by John Michalakes.
37 ! Jonathan D. Beezley has set up and maintained the WRF build and
38 ! execution environment, provided software engineering infrastructure 
39 ! including synchronization with the WRF repository, and was responsibe
40 ! for all aspects of WRF modification. UCD students Minjeong Kim and
41 ! Volodymyr Kondratenko have contributed to the implementation of the
42 ! fire propagation by the level set method.
44 ! Refefences
46 ! [1] Jan Mandel, Jonathan D. Beezley, and Adam K. Kochanski, "Coupled
47 ! atmosphere-wildland fire modeling with WRF 3.3 and SFIRE 2011, 
48 ! Geoscientific Model Development (GMD) 4, 591-610, 2011. 
49 ! doi:10.5194/gmd-4-591-2011
51 ! [2] T. L. Clark, J. Coen, and D. Latham, Description of a coupled 
52 ! atmosphere-fire model, Intl. J. Wildland Fire, vol. 13, pp. 49-64, 
53 ! 2004
55 ! [3] Edward G. Patton and Janice L. Coen, WRF-Fire: A Coupled 
56 ! Atmosphere-Fire Module for WRF, Preprints of Joint MM5/Weather 
57 ! Research and Forecasting Model Users' Workshop, Boulder, CO, 
58 ! June 22-25, 2004, pp. 221-223, NCAR
60 ! --------------------------------------------------------------------
61
62 ! CURRENT ACTIVITY
63
64 ! For current activity and development trends please check out
65 ! http://ccm.ucdenver.edu/wiki/User:Jmandel/blog
66 ! http://www.openwfm.org/wiki/WRF-Fire_development_notes
67
70 ADDITIONAL DOCUMENTATION IN THE doc SUBDIRECTORY
73 README.txt                  this file
74 README_git.txt              how to use the versioning system
75 README_mac.txt              how to run on a Mac
76 README_matlab_netcdf.txt    how to read WRF input and output directly in Matlab
77 README_vis.txt              matlab visualization using files written every timestep
78 README_visualization.txt    convert WRF input and output to Matlab
79 README_wps.txt              how use real data including fuel from Landfire