README.TXT 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. MODTRAN4 INSTALLATION AND I/O FILES
  2. This file outlines the steps required to obtain, install and
  3. execute MODTRAN4 on a UNIX system. It also describes the input/output
  4. (I/O) file structure for MODTRAN. This file should be read even if
  5. one has already installed the code, or is familiar with the installation
  6. process. This file is duplicated as the 'README' file in the MODTRAN
  7. distribution tar file.
  8. The top-level directory for MODTRAN4 is Mod4v1r1/, i.e. MODTRAN4
  9. version 1, revision 1.
  10. For installation questions, contact:
  11. gail.anderson@hanscom.af.mil,
  12. ganderson@cmdl.noaa.gov, or
  13. jim.chetwynd@hanscom.af.mil
  14. With technical questions, contact:
  15. gail.anderson@hanscom.af.mil,
  16. ganderson@cmdl.noaa.gov, or
  17. lex@spectral.com
  18. NEW FEATURES
  19. MODTRAN4 adds the following features (references are in the user manual):
  20. Two Correlated-k (CK) options: the standard option which uses 17 k
  21. values (absorption coefficients) per spectral bin and a slower, 33 k
  22. value option primarily for upper-altitude (>40 km) cooling rate and
  23. weighting function calculations (CARD 1);
  24. An option to include azimuth dependencies in the calculation of DISORT
  25. solar scattering contributions (CARD 1A);
  26. Upgraded ground surface modeling including parameterized forms for
  27. spectral BRDFs (Bidirectional Reflectance Distribution Functions) and an
  28. option to define a ground target surface (H2) different from its
  29. surrounding surface.
  30. A high-speed option, most appropriate in short-wave and UV spectral
  31. regions, that uses 15 cm-1 band model parameters (CARD 1A);
  32. Scaling options for water vapor and ozone column amounts (CARD 1A);
  33. Improved, higher spectral resolution, cloud parameter database; and
  34. More accurate Rayleigh scattering and indices of refraction.
  35. Both Correlated-k options permit more accurate calculation of molecular
  36. absorption in the presence of multiple scattering. Without the azimuth
  37. dependent DISORT option, the multiple (not single) scatter solar
  38. contributions included in MODTRAN line-of-sight calculations are
  39. averaged over azimuth. The BRDFs are fully coupled into the Isaacs multiple
  40. scattering model; upon release of the recently developed BRDF-dependent DISORT,
  41. MODTRAN4 BRDF's will be coupled to that code. The dual surface option enables
  42. modeling of adjacency effects. The updated Rayleigh scattering algorithm
  43. models the spectral dependence of the depolarization factor, and the refractivity
  44. (equal to one minus the real part of the index of refraction) now varies
  45. not only with water density but also with CO2 partial pressure
  46. (Bodhaine, et al., 1999).
  47. All MODTRAN3.5 and MODTRAN3.7 input files are fully compatible with
  48. MODTRAN4. Minimally, six input cards (1, 1A, 2, 3, 4, and 5) are required
  49. to run MODTRAN for a given problem. For specific problems, combinations
  50. of several additional optional control cards are possible.
  51. INSTALLATION STEPS
  52. 1) Contact Gail Anderson (email: gail.anderson@HANSCOM.AF.MIL)
  53. or Jim Chetwynd (jim.chetwynd@hanscom.af.mil) and obtain the code
  54. (bundled into a single UNIX tar file and compressed to save space).
  55. 2) Untar the file: 'tar xvf Mod4v1r1.tar'; this will build the
  56. MODTRAN4 directory structure. The top-level directory, Mod4v1r1/, will
  57. contain these sub-directories: DATA/, docs/, mie/, mod4_obj/, mod4_src/,
  58. novam/, novam/src/, novam/test/, PC/, PC/DATA/, PC/mod4_obj/,
  59. PC/mod4_src/, PC/TEST/ PC/TEST/SAVE/, TEST/ and TEST/SAVE,
  60. 3) Create Correlated-k binary data files in the DATA/ subdirectory.
  61. In that directory, compile CKBIN.f (f77 CKBIN.f -o CKBIN.exe). Run
  62. CKBIN.exe; you will be prompted for a Correlated-k ASCII file name.
  63. Reply 'CORK15.ASC'. This file should have been placed in the DATA/
  64. directory during the untar process. You will then be prompted for a
  65. binary name; reply with 'CORK15.BIN'. The program should announce a
  66. successful write and place the file in the DATA/ directory. Repeat
  67. for 'CORK01.ASC'.
  68. 4) Create band model parameter files. Compile and run MOLBMP.f.
  69. Select an ASCII-to-binary conversion. Although entering names of
  70. ASCII files is possible, the current files of interest should appear
  71. in the menu: BMP99_15.ASC and BMP99_01.ASC. Another menu permits
  72. choosing output file names; select the corresponding .BIN names.
  73. The outputs of the conversions specify the value, for your computer,
  74. of the RECL parameter. Note this number for the following step.
  75. 5) In the mod4_src/ subdirectory, edit the file openbm.f. Find
  76. the 'RECL=' specification in the OPEN statement, and change its value
  77. to that specified by MOLBMP.exe for your platform and compiler. For
  78. an HP 9000/735, for example, the value will be 60; for an SGI, 15; for
  79. GNU and PC (Lahey and WATCOM) compilers, it is also 60.
  80. 6) The command 'make -f Makefile' will run the FORTRAN compiler
  81. (using 'Makefile') to create the executable file Mod4v1r1.exe. Object
  82. files will be placed in the mod4_obj/ directory. You may need to edit
  83. the makefile to set compiler parameters as needed by your compiler.
  84. Most likely, editing will not be needed.
  85. 7) This version of MODTRAN (version 3.7 and higher) has the
  86. ability to use the Navy Oceanic Vertical Aerosol Computer Model (NOVAM).
  87. If you need to use this code, NOVAM must be compiled and run before
  88. MODTRAN, producing output files for use when needed. The NOVAM files are
  89. located in the novam/ subdirectory tree under the top MODTRAN directory.
  90. Not all users will require NOVAM. MODTRAN is independent of NOVAM.
  91. To prepare using NOVAM, go to the novam/ subdirectory. Execute
  92. the UNIX script file createnovamexecutable, which will create the
  93. NOVAM executable, novam.exe. NOVAM (novam.exe) reads input from
  94. novam.in, and writes output to novam.out. Three test case inputs are
  95. located in the novam/test/ subdirectory. Copy one into the novam.in
  96. file name, or create one, and use 'novam.exe' to create novam.out.
  97. Copy that to NOVAM.OUT (upper case) in the topmost MODTRAN directory,
  98. which contains Mod4v1r1.exe, for use in runs requiring NOVAM data.
  99. 8) The TEST subdirectory holds a number of input files designed
  100. to exercise various parts of MODTRAN4. The input files are named in
  101. the pattern *.tp5; output files have .tp6, .tp7, .tp8, .7sc, .7sr,
  102. .plt, .psc, .clr, .chn, and .flx extensions. Copy a *.tp5 file into
  103. tape5 in the top-level directory, and then 'Mod4v1r1.exe' will run that
  104. case. The other way of running MODTRAN and naming I/O files make use
  105. of the file 'modroot.in' or 'MODROOT.IN' as described below. For
  106. MODTRAN4, the *.tp6 output files shipped were created on a UNIX platform.
  107. 9) The subdirectory 'PC/' contains an executable, and binary
  108. files, for a PC. You need not compile the DATA/ files for the PC.
  109. I/O FILES
  110. An attempt has been made in MODTRAN4 to make it easier for
  111. the users to keep track of input and output (I/O) files. The need for
  112. easier file handling is evident to anyone who runs MODTRAN using
  113. different tape5's and wants to save the corresponding output files
  114. (the tape6's, pltout's, tape7's and so on). The problem is that every
  115. MODTRAN input file must be called 'tape5' and that earlier I/O files
  116. must be renamed to avoid overwriting them with newer files. The need
  117. for renaming is now avoided by creating a new MODTRAN input file
  118. (referred to as the root name file) called modroot.in or MODROOT.IN.
  119. If 'modroot.in' does not exist, 'MODROOT.IN' is looked for. If
  120. neither exists, MODTRAN I/O files are the usual ones: 'tape5',
  121. 'tape6', 'tape7', 'tape8', etc. If the root name file exists and
  122. contains a non-null string (maximum length is 80 characters), this
  123. string is treated as a prefix. It is suggested that this string
  124. contain no blanks other than leading and trailing ones. If the string
  125. consists of all blanks or is a null string, the I/O files are the
  126. usual ones. Otherwise, this string, stripped of all leading and
  127. trailing blacks, is used as a prefix for the I/O files whose names
  128. have mnemonic suffixes listed below. As an example, if the string is
  129. 'case1', the MODTRAN I/O files will have these names:
  130. case01.tp5 (corresponding to tape5)
  131. case01.tp6 (corresponding to tape6)
  132. case01.tp7 (corresponding to tape7)
  133. case01.tp8 (corresponding to tape8)
  134. case01.7sc (corresponding to tape7.scn
  135. case01.7sr (corresponding to tape7.scr)
  136. case01.plt (corresponding to pltout)
  137. case01.psc (corresponding to pltout.scn)
  138. case01.clr (corresponding to clrates in MODTRAN4)
  139. case01.chn (corresponding to channels.out in MODTRAN4)
  140. case01.flx (corresponding to specflux.out in MODTRAN4)