updated README.txt - standalone model_test only, some typos
[wrffire.git] / README.txt
blob973bf07a085738c8696d5ecf35884fc6dce87dc8
1 Index of documentation in doc subdirectory
3 README.txt                  this file, how to compile and run WRF/SFIRE on ideal data
4 README_git.txt              how to use the versioning system
5 README_mac.txt              how to run on a Mac
6 README_matlab_netcdf.txt    how to read WRF input and output directly Matlab
7 README_vis.txt              matlab visualization using files written every timestep
8 README_visualization.txt    convert WRF input and output to Matlab readable format
9 README_wps.txt              how use real data including fuel from Landfire
12 *** All is set up to run on wf.cudenver.edu ONLY ***
13 *** See the bottom of this file how to set up another machine ***
16 BRANCHES
18 The repository contains these main branches:
20 * master : stable branch 
21 * jbeezley  
22 * jc 
23 * jm: current working branch
24 * jm-base: early snapshot that gives the same output as Ned had
26 Only Jon can commit to master branch in the repository.
27 Each branch has owner and one the owner can commit to that branch in the
28 repository.
29 If you want to have more than one branch have Jon set up a branch (say, jm2)
30 and then use it as a kind of directory, as in notation, as jm2/newtest
32 RUNNING
34 Make sure you source either env.sh (for sh shells) 
35 or env.csh (for csh shells) to set up environment
36 variables for building. Then,
39 cd wrfv2_fire
40 ./configure # select an option for your computer,
41             # the configuration options present have all been tested
42             # and should work correctly for the intended computer
43             # If you are trying to get this working on a different
44             # computer, try copying wrfv2_fire/arch/configure.defaults_orig
45             # to configure.defaults, this file contains all standard
46             # configuration options, but are untested... good luck.
47 ./compile em_fire >& compile.log
49 This will take a while.  Make sure that compile.log contains 
50 no errors.  ("grep Error compile.log" shouldn't return anything).
51 Or, just run
53 ./compile_fire
55 and then check compile.log only if you see any output.
57 Finally, run the code with:
59 cd test/em_fire 
60 ./run_me_first.csh (needs to be done only once)
61 ./ideal.exe >& ideal.log (this creates file wrfinput_d01, needs to be done only
62 when input_sounding changes)
63 ./wrf.exe
65 Or, just run the debugger, it is set up to load the program automatically and set 
66 a breakpoint at exit, esp. error exit:
68 cd test/em_fire 
69 idb -dbx
71 This runs an "idealized" problem. For RUNNING ON REAL DATA see doc/README_wps.txt
74 STANDALONE FIRE MODEL TEST
76 with ifort:
78 cd phys
79 ./ifmake clean
80 ./ifmake model_test
82 Without the clean between different kind of builds nothing will work.
83 There is g95make for g95.
84 With other compilers, try someting like make -f testmakefile FC=your fortran compiler
85 See wrfv2_fire/phys/README_jm.txt for more info.
90 SETUP ON A NEW MACHINE
92 Tested on linux/ifort, linux/pgi, and mac/g95. Mac will not run optimized or real data, though.
93 Ask Jon if you need more architectures to be added to the menu that shows in ./configure.
95 You need to install NETCDF and modify the environment variables accordingly.
96 You can make your own copy of env.csh (under a different name)
97 to set up the environment but please do not commit changed env.csh
99 To install NETCDF: Donload from the web and install per the istructions therein.
100 The current and tested version is 4.0. Use the compilers you will use for wrf.
102 Set environment variable to the top level netcdf directory like:
103 setenv NETCDF /opt/wrf-libs/netcdf
104 (of course, replace the path by the location where you put netcdf)