home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / astronom / gocane10.zip / GC.DOC < prev    next >
Text File  |  1993-09-01  |  19KB  |  424 lines
  1. +-----------------------------------------------------------------------------+
  2. |              Go 'Canes,  A Modern Hurricane Tracking Program                |
  3. |                            Version 1.0                                      |
  4. |                  Color VGA and a text editor required.                      |
  5. |                  Ramdrive and/or disk cache will help.                      |
  6. +-----------------------------------------------------------------------------+
  7.  
  8. QUICK START
  9.  
  10. Type GC at the DOS prompt, then Alt-G at the Configuration Screen. You'll
  11. figure it out.
  12.  
  13. Nice huh?
  14.  
  15. Go 'Canes was will plot both developing and historical storms.  It is not a
  16. Youth Fair Science Project. It will run directly from the Configuration
  17. Screen, or from the command line.
  18.  
  19. Through its Custom Maps, Tag Screen, and ability to accept command line
  20. parameters, Go 'Canes was designed to enable you to track tropical cyclones
  21. dynamically.
  22.  
  23. SEE later in this doc, COMMAND LINE USAGE
  24. SEE also in this ZIP, README.2ND
  25.  
  26. For those who do not feel documents are for cowards, let's plunge ahead.
  27.  
  28. THE CONFIGURATION SCREEN
  29.  
  30. Here's the Configuration Screen with the default configuration (GC.CFG)
  31. loaded.
  32.  
  33. +=============================================================================+
  34. |       GO 'CANES            Configuration Screen          v1.0               |
  35. |=============================================================================|
  36. |          Current Map   1                  |        MAPS AVAILABLE           |
  37. | Current Storm / List   ANDREW.'92         |                                 |
  38. |-------------------------------------------|    1) North Atlantic            |
  39. |      SlowDown Factor   10                 |    2) Windward Islands          |
  40. | Pause Between Storms   Y                  |    3) Caribbean and Gulf        |
  41. |-------------------------------------------|    4) North East US Coast       |
  42. |        User Latitude   25.408             |    5) Eastern Pacific           |
  43. |       User Longitude   80.375             |    6) NW Gulf Coast             |
  44. |-------------------------------------------|    7) Key W to Cape Hat         |
  45. |   Custom Map 6 Title   NW Gulf Coast      |                                 |
  46. |     Maximum Latitude   31.5               +---------------------------------|
  47. |    Maximum Longitude   98.5               |                                 |
  48. |               Height   5                  |   Alt-P    Set Storm Files PATH |
  49. |-------------------------------------------|   Alt-T    TAG Storms           |
  50. |   Custom Map 7 Title   Key W to Cape Hat  |   Alt-G    GO to Map            |
  51. |     Maximum Latitude   37                 |   Alt-S    SAVE Configuration   |
  52. |    Maximum Longitude   82                 |   Alt-X    EXIT Program         |
  53. |               Height   13                 |                                 |
  54. +=============================================================================+
  55.  
  56. On the left are 14 Configuration Fields ready for editing. On the top right
  57. are a list of the available Maps.  Both will be discussed later. On the
  58. lower right are the five available commands.  They are fairly self evident,
  59. but we have to start somewhere.
  60.  
  61. THE COMMANDS
  62.  
  63. Alt-P   Set Storm Files PATH  If you have a lot of storm files, you may want
  64. to keep your storm files in various directories.  This command will let you
  65. set the directory that Go 'Canes will search for storms.  All Storms, Storm
  66. Lists, and Storms or Lists given on the command line must be present in the
  67. directory indicated in the Storm Files Path.
  68.  
  69. Alt-T   TAG Storms  You can open the directory that you have set with the
  70. PATH command and tag storms for viewing.  The Tag Screen includes
  71. instructions for sorting and tagging the storms.  If there are more than 100
  72. storms, PgUp/PgDown will switch between screens.  Only 200 storms can be
  73. loaded at a time, and only 99 can be tagged.
  74.  
  75. Alt-G   GO to Map  This command will draw the selected Map and plot the
  76. selected Storms(s).  After the plot, a two tone beep will sound, and any key
  77. will return you to this Configuration Screen.  If the Storm / List field is
  78. empty, Alt-G will only draw the map, returning to the Configuration Screen
  79. as above.  This is handy when tweaking a Custom Map.  Escape will exit a
  80. storm plot.  Alt-X at the map screen will exit the program.
  81.  
  82. Alt-S   SAVE Configuration to GC.CFG   This command saves your current
  83. configuration to disk so it will become the default and be loaded the next
  84. time you run the program.  Your existing GC.CFG will be overwritten.
  85.  
  86. Alt-X   EXIT   Goodbye, Over, Done.  Alt-X will also exit directly from the
  87. map once a plot is completed.  If you are pleased with your current
  88. configuration, you should save it first with the SAVE command above.
  89.  
  90. GC.CFG  THE CONFIGURATION FILE
  91.  
  92. GC.CFG contains the information shown on the Configuration Screen. It will
  93. help you to know what the requirements and limits are for each field. You
  94. can easily edit GC.CFG with your text editor, but changes are more easily
  95. made right from the Configuration Screen.
  96.  
  97. Below are the 15 fields of the configuration file as supplied with the
  98. program. Each field is shown here on its own line, followed by an
  99. explanation of the field. This should prove useful no matter how you edit
  100. your configuration.
  101.  
  102. Skilful use of the DOS copy command will allow you to have multiple
  103. configurations by swapping files.  If GC.CFG is not found or corrupt,
  104. Go 'Canes will create a new (this) one and ask you to restart the program.
  105.  
  106. field               description
  107. --------------------------------------------------------------------------
  108. 1                 ; current map - integer from 1 to 6
  109. ANDREW.'92        ; current storm or list
  110. 10                ; slowdown factor for plots 0 = FASTEST,       decimals OK
  111. Y                 ; pause between storms in a list [Y/N]
  112. 25.408            ; user latitude     (currently Homestead AFB)
  113. 80.375            ; user longitude
  114. NW Gulf Coast     ; custom map 1 title - text, 17 characters max
  115. 31.5              ; custom map 1 maximum latitude   = top edge   decimals OK
  116. 98.5              ; custom map 1 maximum longitude  = left side      "
  117. 5                 ; custom map 1 height (latitude) in degrees        "
  118. Key W to Cape Hat ; custom map 2 title   text, 17 characters max
  119. 37                ; custom map 2 maximum latitude   = top edge       "
  120. 82                ; custom map 2 maximum longitude  = left side      "
  121. 13                ; custom map 2 height (latitude) in degrees        "
  122. .\                ; storm file path   (.\ = current directory)
  123. --------------------------------------------------------------------------
  124.  
  125. THE MAPS  (The First Field)
  126.  
  127. The first field of the Configuration List must contain a single digit from 1
  128. to 7 to tell Go 'Canes which Map you want to use.
  129.  
  130. Seven maps are available. The first five are hard-coded, the last two can be
  131. defined by the user as Custom Maps (more below). The hard-coded maps are:
  132.  
  133.     1) North Atlantic
  134.     2) Windward Islands
  135.     3) Caribbean and Gulf
  136.     4) North East US Coast
  137.     5) Eastern Pacific
  138.  
  139. Seeing them beats describing them.
  140.  
  141. The 2 Custom Maps included are:
  142.  
  143.     5) NW Gulf Coast
  144.     6) K West to Hatteras
  145.  
  146. However, these Custom Map fields are provided so you can adapt them to the
  147. particular storm you are tracking.
  148.  
  149. STORM FILES AND LISTS  (The Second Field)
  150.  
  151. From the Configuration Screen, storm data can be passed to Go 'Canes in two
  152. ways:
  153.  
  154.     1) Files containing single storms      ie: ANDREW.'92
  155.     2) Files containing lists of storms.   ie: 1993.LST
  156.  
  157. Files and lists can also be passed on the command line;  groups of storms
  158. can be tagged by selecting the TAG option.
  159.  
  160. Go 'Canes determines the type of file by its extension.  List files MUST
  161. HAVE THE EXTENSION ".LST". There, I said it.  Lists must be maintained in
  162. the storm files directory indicated by the storm files PATH.
  163.  
  164. Files containing a single storm can have any DOS compliant name, but the
  165. usual format is "hurname.'year" as in: ANDREW.'92  The apostrophe is
  166. necessary if you wish to use the TAG feature.
  167.  
  168. Either a Storm File or a Storm List can be used in the Storm / List field of
  169. the Configuration Screen.
  170.  
  171. STORM FILES
  172.  
  173. Storm Files are comma delimited ASCII files with 5 fields. They can be
  174. created and maintained with any text editor.  If you must use a word
  175. processor, use ASCII, DOS text, or non-document mode. The 5 fields are:
  176.  
  177.   field            example        comment
  178.  -------          --------        ---------------------------------
  179.  1) Date          08/23/92,     ; any delimiter will do, I use "/"
  180.  2) Time          23:00,        ; use 24hr format (*) see below
  181.  3) Latitude      25.4,         ; to one decimal place
  182.  4) Longitude     78.1,         ; as above, western (all) longitude positive
  183.  5) Wind Speed    145,          ; in MPH
  184.  6) Pressure      923           ; barometric pressure in millibars
  185.  
  186. The above standards are the ones used by most sources of hurricane data. See
  187. the file README.2ND for more information on obtaining current hurricane
  188. coordinates.
  189.  
  190. (*) The time you use is up to you. You can use GMT if you wish, but this will
  191. involve translation from your data source then back to your local time when
  192. necessary.  I use the time given by the National Hurricane Center, which
  193. are usually the time zone of the storm's current location.
  194.  
  195. Here's what Andrew's data file looked like as he approached Homestead.
  196.  
  197.                  08/23/92,23:00,25.4,78.1,145,923
  198.                  08/24/92,02:00,25.4,78.9,140,941
  199.                  08/24/92,05:00,25.4,80.3,140,941
  200.  
  201. Using leading zeroes in the date and time fields make these files easier to
  202. read and maintain.  There MUST NOT be any blank lines at the end of the
  203. storm file.
  204.  
  205. The package includes files for an assortment of storms, both Atlantic and
  206. Pacific.
  207.  
  208. STORM LISTS
  209.  
  210. A Storm List is no more than a file WITH THE EXTENSION ".LST", containing a
  211. list of the names of the storm files you wish to plot sequentially.
  212.  
  213. Here is the contents of MYLIST.LST, supplied in the package.
  214.  
  215.     HUGO.'89
  216.     ANDREW.'92
  217.     GILBERT.'88
  218.  
  219. You can create your own lists, with storms arranged by any criteria: year,
  220. season, location, pretty patterns, old girlfriends/boyfriends. Use your
  221. imagination.
  222.  
  223. PLOTTING STORM(S)
  224.  
  225. Once the selected map is drawn,  the storm(s) will begin to plot.  ESC will
  226. abort a plot.
  227.  
  228. The name of the storm will appear on the right of the screen, followed by
  229. the date and time.  On the next line will appear the letters L/L: followed
  230. by the latitude and longitude, and the letters S\P: followed by the (wind)
  231. Speed and (barometric) Pressure.
  232.  
  233. The color of the plot changes with the storm's wind speed.
  234.  
  235.      Wind Speed     Category of Storm        Color
  236.    ------------   ---------------------    ------------
  237.         < 35      Tropical Depression      Dark Green
  238.       35 to  74   Tropical Storm           Bright Green
  239.       75 to  95   Category   I Hurricane    Yellow
  240.       96 to 110   Category  II Hurricane     White
  241.      111 to 130   Category III Hurricane      "
  242.      131 to 155   Category  IV Hurricane     Red
  243.         > 155     Category   V Hurricane      "
  244.  
  245. SLOWDOWN FACTOR (The Third Field)
  246.  
  247. Storms will move across the Map at speeds that vary with the speed of your
  248. computer.  The SlowDown Factor gives you a way to control this speed. My
  249. 486/66 enjoys a factor of 15.  Slower computers will need a lower number.
  250. Decimal values are acceptable. (Decimal values will only fit, and should
  251. only be needed, with factors under 10.) The Slowdown factor does not affect
  252. the maps, which draw as fast as your computer will load them.
  253.  
  254. PAUSE BETWEEN STORMS (The Fourth Field)
  255.  
  256. When running a Storm List, this field gives you the option to pause between
  257. the storms in the list.  If this field is set to "Y", a beep will sound at
  258. the end of each plot and the word "more" will appear on the screen. Any
  259. keystroke will start the next storm plot. This field accepts a "Y" or an
  260. "N".
  261.  
  262. USER LATITUDE (The Fifth Field), and
  263. USER LONGITUDE (The Sixth Field)
  264.  
  265.     Enter your (or any) latitude and longitude in these two fields. A small
  266. red circle will appear on all maps at that location.  The default location
  267. is Homestead Air Force Base.
  268.  
  269. CUSTOM MAPS (Two Maps, Fields Seven through Fourteen)
  270.  
  271. Custom Maps are not intended to be static, but to be re-defined as a storm
  272. develops.
  273.  
  274. Go 'Canes includes an option for two user defined maps, maps number 6 and 7.
  275. Map number 6 is defined on lines 7 through 10 of GC.CFG, and map number 7 on
  276. lines 11 through 14.
  277.  
  278. Since each map uses four fields, I will consider only one map, and refer to
  279. the fields as one through four.
  280.  
  281. Enter the name of the map in field one.  You may use up to 17 characters.
  282. After a plot, the map name entered here will appear on the Configuration
  283. Screen under MAPS AVAILABLE, if you save the configuration with Alt-S, the
  284. map will become the default for that map number.
  285.  
  286. Approximate where you want the upper left corner of your map. Enter the
  287. maximum (upper) latitude in field two, and the maximum (leftmost) longitude
  288. in field three. Finally, estimate how many degrees high you want the map to
  289. be, and enter the height in degrees in field four. See the sketch below.
  290.  
  291.                       |     MAX LAT
  292. upper left corner > --*-------------              --
  293.                       |   ^                          |
  294.                     M |   |
  295.                     A |   |
  296.                     X |   |
  297.                       | height
  298.                     L |   |         YOUR
  299.                     O |   |         MAP
  300.                     N |   |                          |
  301.                       |   |                          |
  302.                       |   |                          |
  303.                       |   v                          |   Go 'Canes will
  304.                     ----------                ------(*)  find this corner
  305.  
  306.  
  307. Defining a custom map that falls outside the area of Map 1, The North
  308. Atlantic, will cause an error message. You will then be able to adjust your
  309. parameters. No Custom Maps are permitted in the Pacific.
  310.  
  311. The extreme coordinates of Map 1 are:
  312.  
  313.   maximum latitude: 50, maximum longitude: 100     ; upper left corner
  314.  
  315.   minimum latitude:  0, minimum longitude:  15     ; lower right corner
  316.  
  317. To hack a Custom Map, start by plotting Map 1, The North Atlantic.  You can
  318. find the latitude listed in 10 degree intervals (on the right), and
  319. longitude (across the bottom) of Map 1, (or any hard-coded map). Note the
  320. uppermost and leftmost edges of the area you want to include in your map.
  321. Estimate the coordinates of that point by referring to the edges of the map.
  322. Estimate how high, in degrees, you want the map to be.  Perhaps jot the
  323. three numbers down.
  324.  
  325. Return to the Configuration Screen.  Enter the upper edge of the desired map
  326. in field two (Maximum Latitude), the left edge in field three (Maximum
  327. Longitude), and the height in field four.
  328.  
  329. Blank out the Storm / List field.  When you do this,  Go 'Canes will not plot
  330. storms. You can now go back and forth rapidly from your trial map to the
  331. Configuration Screen. Thusly tweaking your Custom Map to its final
  332. perfection.
  333.  
  334. Remember to set field 1,  Current Map, to the number of your Custom Map,
  335. either 6 or 7.
  336.  
  337. Hit Alt-G to draw your map.
  338.  
  339. The program will compute the other parameters to make a nice projection. For
  340. the purposes of hurricane tracking a height of 7 - 8 degrees is quite small.
  341. The program will not allow heights of less than one degree.
  342.  
  343. One custom map could be maintained to show the approach to a specific
  344. location.  If you configure a large scale (read *large height*) custom map
  345. with the specific location nestled just inside the upper left corner, you
  346. can change the scale of the map quickly by changing ONLY the height of the
  347. map.  If you scale (read *change height*) reasonably, the location will
  348. always be on the map.
  349.  
  350. COMMAND LINE USAGE
  351.  
  352. Go 'Canes will accept two parameters on the command line for immediate
  353. plotting of storms, or for batch file usage. The first parameter is a file,
  354. either a Storm or a List.  The second, optional, parameter is the number of
  355. the map to use for the plot.  The parameters must be separated by a space,
  356. and ONLY a space.
  357.  
  358.    GC stormname.ext | listfile.LST [mapnumber]
  359.  
  360.      Examples:
  361.  
  362.    GC ANDREW.'92 3
  363.  
  364.      Will immediately start the plot of Andrew on Map number 3.
  365.  
  366.    GC ACTIVE.LST
  367.  
  368.      Will open ACTIVE.LST and plot the storms on the current default map.
  369.  
  370. If the Map Number is omitted on the command line, the storm will be plotted
  371. on the default map indicated in the Configuration File. The Map Number may,
  372. of course, be one of your very own Custom Maps. A command line MAY NOT
  373. consist of a Map Number alone.  All Storms and Lists given on the command
  374. line must exist in the directory indicated by the Storm File PATH.
  375.  
  376. AUTHORSHIP / DISTRIBUTION
  377.  
  378. Go 'Canes was written by:
  379.  
  380.     Robert Terwilliger
  381.     2398 SW 22nd Ave
  382.     Miami, FL  33145
  383.  
  384.     CompuServe 71034,3445
  385.  
  386. Go 'Canes is copyright by the author (c) 1993, and is distributed under the
  387. ShareWare principal. If you do not know what that means, ask around.
  388.  
  389. If you enjoy the program, please send $15.00 to the above address. All
  390. registered users will receive notification of the inevitable next version.
  391. It seems one never really feels a program is finished, but I wanted to get
  392. Go 'Canes out before the end of the 1993 hurricane season.  Many
  393. improvements are planned, and there will be a 1994 version, which will
  394. hopefully eliminate any bugs found in v1.0 by users. Please send any
  395. comments or bug reports to me via Compuserve or at the above address.
  396.  
  397. Those wishing to receive the 1994, and hopefully final, version, when it is
  398. completed (definitely by June 1, 1994) please send $35.  This will include a
  399. selection of greatest hits from my collection of 907 storms dating back to
  400. 1886.
  401.  
  402. The complete collection of 907 storms is available zipped for $15. Specify
  403. media.
  404.  
  405. PRODUCT SUPPORT
  406.  
  407. Available to all for this version, by mail via the address above or via
  408. CompuServe as above. Please, no telephone calls.
  409.  
  410. CREDITS / DISCLAIMER
  411.  
  412. HURRICANES ARE SERIOUS BUSINESS. *WE* KNOW WHERE THEY ARE, AND WHERE THEY
  413. ARE HEADED. KEEP INFORMED, PLAN AHEAD, AND BE PREPARED.
  414.  
  415. The Go 'Canes Maps contain data placed in the public domain by Fred
  416. Pospeschil and Antonio Riveria.  The bulk of the original coordinate data
  417. was created by the Central Intelligence Agency.
  418.  
  419. This program is intended for no purposes other than entertainment. In the
  420. impossible event this program damages your system or data, goods or
  421. chattels, pets or small children, and you think you can prove it, sue The
  422. Microsoft Corporation, authors of QuickBASIC, the Environment From Hell.
  423. They have money.  Any trademarks are exactly that.
  424.