home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR18 / SOL25_3.ZIP / GRAPH.DOC < prev    next >
Text File  |  1993-10-25  |  21KB  |  381 lines
  1.  
  2.         ╔══════════════════════════════════════════════════════════════╗
  3.         ║      Propagation Forecast Bulletin Graphic Plot Utility      ║
  4.         ║                        Version 2.5                           ║
  5.         ║                                                              ║
  6.         ║                  Program file GRAPH.DOC                      ║
  7.         ╚══════════════════════════════════════════════════════════════╝     
  8.         ┌──────────────────────────────────────────────────────────────┐
  9.         │              Background and General Information              │
  10.         └──────────────────────────────────────────────────────────────┘
  11.  
  12.      I don't claim to be an expert on solar activity; in fact, that was why I
  13.      wrote this program.  I really enjoy reading Tad Cook's PROPAGATION
  14.      FORECAST BULLETIN each week (transmitted on W1AW and available on many
  15.      Packet BBS's) but I needed some way to put his sunspot and solar flux
  16.      values into a format I could relate to my on-the-air experience.  This
  17.      little program lets me do that by plotting the sunspot and solar flux
  18.      values from the PROPAGATION FORECAST BULLETINS in a graphic format.  I
  19.      can look at the plot and look at my logbooks and see why the band was
  20.      dead on a particular day, or why propagation was so good on a particular
  21.      day.
  22.  
  23.      This is not a real fancy program.  It doesn't do MUF plots or anything
  24.      like that.  It is just a utility that puts things into perspective for
  25.      you, and makes them easier to visualize.  It will hold up to about 2400
  26.      daily entries for sunspot and 10.7cm solar flux values.  The data is
  27.      displayed graphically on two screens; one is an overall view showing all
  28.      of the data from day one to day "x".  The second is a close-up view of
  29.      196 entries.  When the data file gets quite large the entries get so
  30.      close together that it is difficult to see anything on the "Overall"
  31.      screen.  Also, when you are viewing just a portion of the data it is
  32.      difficult to get the "Big Picture".  Therefore, I give you two screen
  33.      modes. The overall is generally used for getting an overall view of the
  34.      data and the close-up screen is used for looking at more precise
  35.      information.  The close-up screen may be "Panned" left or right to scroll
  36.      through the data file month-by-month.
  37.  
  38.      The vertical divisions on the screen correspond to days and weeks.  The
  39.      days are drawn in gray dotted lines and the weeks are in blue dotted
  40.      lines.  Monthly divisions (every 28 days starting at the beginning of the
  41.      file) are drawn in solid lines.  On the overall screen, the "Day" lines
  42.      have been omitted since they are normally too close together to see.
  43.  
  44.      The program was designed to use a Microsoft(tm) compatible mouse as a
  45.      pointing device.  It does not require one, but you really need one to get
  46.      the most out of the software.  When a mouse is in use, you can "Click" on
  47.      an area of the overall screen and the software will automatically switch
  48.      to the close-up screen with the selected area in the center of the
  49.      screen.  Also, when a Mouse is used, the current position of the Mouse
  50.      cursor is displayed on the screen.  This allows you to measure values
  51.      from the screen.
  52.  
  53.         ┌──────────────────────────────────────────────────────────────┐
  54.         │                     Hardware Requirements                    │      
  55.         └──────────────────────────────────────────────────────────────┘      
  56.  
  57.      This program was designed for the IBM-PC(tm) and compatible computers 
  58.      with the MS-DOS(tm) operating system, Version 2.1 or later with at least 
  59.      128 Kbytes of available memory.  An EGA or VGA video adapter and monitor 
  60.      are required, and a Microsoft(tm) compatible Mouse is recommended but not 
  61.      required.  A hard disk drive with enough capacity to store the program 
  62.      and data files is highly recommended.
  63.  
  64.                                    Page 1
  65.  
  66.         ┌──────────────────────────────────────────────────────────────┐
  67.         │                        Program Use                           │
  68.         └──────────────────────────────────────────────────────────────┘
  69.  
  70.      Once activated, the program will read the data from the specified data
  71.      file and generate a set of averages. The initial display will be on the
  72.      close-up screen with the LAST day in the file at the right side of the
  73.      screen.  Vertical bars denote the days (dotted lines), weeks (bright
  74.      dotted lines), and months (solid lines) within the file.  Months as used
  75.      here are defined as 4 weeks or 28 days.  The day, week, and month lines
  76.      are all blue.  The number of sun-spots for each day are plotted as a
  77.      green line with the sun spot average plotted as a dotted cyan (light
  78.      blue) line.  The 10.7cm solar flux values are plotted as a violet line
  79.      with the averages plotted as a dotted red line.
  80.  
  81.      Those of you with slower machines (especially the old 8086 machines like
  82.      I have) should be aware that it may take around a minute to do the
  83.      average calculations.  When the program is started, a bar on the title
  84.      screen will show the amount of data read, and the amount of the averages
  85.      that have been calculated. When the average interval or "Lag" days (see
  86.      below) are changed the averages have to be recalculated, so the
  87.      percentage completed is shown again during the recalculation.  With
  88.      faster machines the average calculations only take a few seconds; my
  89.      40 mHz 386 machine only takes about 8 seconds as opposed to 55 seconds
  90.      on my 10 mHz 8086 machine.  A math coprocessor speeds it up to less than
  91.      2 seconds on a fast machine.
  92.  
  93.      Both the sunspot and flux values have the same scale.  A sunspot value of
  94.      100 will be exactly the same height as a solar flux value of 100.  The
  95.      higher on the screen, the higher the value.
  96.  
  97.      The overall screen uses a reduced scale.  I initially wrote the program
  98.      without any scaling of the overall data, but it was so difficult to see
  99.      that I decided to scale it.  The vertical lines were so high in
  100.      comparison to the horizontal divisions that it was impossible to see
  101.      anything.  With the reduced scale, the more entries you have in the data
  102.      file, the smaller the height of the data.  In other words, as the data is
  103.      compressed across the screen, it is also compressed vertically to make it
  104.      easier see.
  105.  
  106.      At the top of the screen is displayed the data for the currently selected
  107.      day. The "Currently Selected Day" is shown by an arrow at the bottom if
  108.      the screen if a Mouse is not in use, or by the Mouse cursor if a Mouse is
  109.      used.  The data that is displayed is the date, number of sun spots, and
  110.      the solar flux from the data file.  If you are using a Mouse, the current
  111.      vertical position of the Mouse cursor is also shows so that you may
  112.      "Measure" a value from the screen.
  113.  
  114.      The left side of the screen shows:
  115.  
  116.          o  The number of entries in the data file
  117.          o  The number of days to be displayed on the close-up screen
  118.          o  The number of days in the averaging period
  119.          o  The number of days lag in the averaging period
  120.  
  121.      There are only a few keyboard commands to remember.  The next page (3)
  122.      is a summary of them:
  123.  
  124.  
  125.  
  126.  
  127.                                    Page 2
  128.  
  129.         ┌──────────────────────────────────────────────────────────────┐
  130.         │                      Keyboard Commands                       │
  131.         └──────────────────────────────────────────────────────────────┘
  132.  
  133.      [S] .... Toggles between the OVERALL screen and the CLOSE-UP screen.
  134.               If you are in one screen mode, the program will switch to the
  135.               other mode.
  136.  
  137.      [A] .... Select a different averaging period.  By default, the program
  138.               uses a 28-day averaging period (since the solar rotation
  139.               period is 27.5 days, this works pretty well), however you may
  140.               set the period for any desired value between 1 and the number
  141.               of days in the file.  More about the averaging later!
  142.  
  143.      [L] .... Changes the number of "Lag" days in the averaging period.
  144.               This is explained in the section below!
  145.  
  146.      [C] .... Defines whether cumulative averages for the first and last
  147.               part of the data file are displayed or not.
  148.  
  149.      [D] .... Changes the number of days displayed on the close-up screen.
  150.               By default the program uses 196 days (or 28 weeks).  This
  151.               gives a pretty good display with enough room between the days
  152.               to see them.  If for some reason, you wish to use a larger or
  153.               smaller number of days, you may set the value by pressing the
  154.               [D] key and then entering the desired number of days to be
  155.               displayed.
  156.  
  157.      [PG UP]. This is used to "Pan" the display left (or toward the TOP of
  158.               the data file). It is only active in the Close-up screen.
  159.  
  160.      [PG DN]. This is used to "Pan" the display right (or toward the BOTTOM
  161.               of the data file). It is only active in the Close-up screen.
  162.  
  163.      [LT ARR] The left arrow key moves the "Current Day" marker to the left
  164.               one day.  The data for the current day (shown at the top of
  165.               the screen) is updated to reflect the new day.  This key is
  166.               active only when a Mouse is not used.
  167.  
  168.      [RT ARR] The right arrow key moves the "Current Day" marker to the
  169.               right one day.  The data for the current day (shown at the
  170.               top of the screen) is updated to reflect the new day.  This
  171.               key is active only when a Mouse is not used.
  172.  
  173.      [?] .... Displays this HELP file!
  174.  
  175.      [ESC] .. Exits the program and returns to DOS command level.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.                                    Page 3
  191.  
  192.         ┌──────────────────────────────────────────────────────────────┐
  193.         │                        Mouse Commands                        │
  194.         └──────────────────────────────────────────────────────────────┘
  195.  
  196.      If you are using a Microsoft(tm) Compatible Mouse, your Mouse buttons
  197.      can be used like the [PG UP] and [PG DN] keys in the close-up screen.
  198.      When you are in the overall screen, you can select an area to look at
  199.      on the close up screen by placing the Mouse cursor on the desired area
  200.      and pressing the LEFT Mouse button.  The program will then switch to
  201.      the close-up screen with the identified day at the center of the
  202.      screen.                                                                  
  203.  
  204.         ┌──────────────────────────────────────────────────────────────┐
  205.         │                   User-Definable Parameters                  │
  206.         └──────────────────────────────────────────────────────────────┘
  207.  
  208.      There are four "User-definable" parameters; the number of days on the
  209.      close up screen, the number of days in the averaging period, the number
  210.      of "Lag" days, and whether "Cumulative Averaging" is on or off.  As
  211.      described above, all of these values have defaults that are used until
  212.      you change one.  When you change one (or more) of the defaults, a
  213.      configuration file is created to retain the new default values so that
  214.      they will be in effect the next time you run the program. The file is
  215.      named GRAPH.CFG, and if you want to edit this file you can, it is just
  216.      an ASCII file.  The first line is the number of days on the close-up
  217.      screen, the second is the number of days in the averaging period, the
  218.      third is the number of lag days, and the fourth line is either a one or
  219.      a zero to define whether cumulative average display is on or off.  To
  220.      just reset everything to the default values, you can just delete the
  221.      file GRAPH.CFG.
  222.  
  223.         ┌──────────────────────────────────────────────────────────────┐
  224.         │                     More About Averaging                     │
  225.         └──────────────────────────────────────────────────────────────┘
  226.  
  227.      Tad Cook (KT7H) has been a great help in getting me straightened out on
  228.      how averages should be done. The averaging in this program uses a
  229.      moving-window average where each day on the average line represents a
  230.      value that is the average of a number of days before and after the
  231.      current day.  The sketch below may help you visualize this:
  232.  
  233.               <-------------- 28 Day Averaging Period -------------->
  234.               ┌─────────────────────────┬───────────────────────────┐
  235.                13 Days Before + Current         14 Days After                
  236.      ─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─
  237.      <------------------------- Days in Data File --------------------------->
  238.  
  239.      The average for the current day is calculated by adding the values for
  240.      a certain number of days before and including the desired day and a
  241.      certain number of days after, then dividing by the number of days in
  242.      the period.  This means that the "Window" from which the average is
  243.      calculated "Moves" as the days progress through the data file.  The
  244.      number of days in the averaging period may be defined using the [A]
  245.      key.                                                                     
  246.  
  247.      Now, as shown in the following sketch, the number of days "Lag" also
  248.      comes into play.  Another method of averaging uses the number of days
  249.      in the period BEFORE the desired day to calculate the average.  For a
  250.      28 day period, the average value for any particular day uses the values
  251.      for the previous 27 days, along with the current day's value to
  252.      calculate the average.
  253.                                    Page 4
  254.  
  255.         ┌──────────────────────────────────────────────────────────────┐
  256.         │                   More About Averaging (cont.)               │
  257.         └──────────────────────────────────────────────────────────────┘
  258.  
  259.               <-------------- 28 Day Averaging Period -------------->
  260.               ┌─────────────────────────────────────────────────────┐
  261.                            27 Days Before + Current Day
  262.      ─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─
  263.      <------------------------- Days in Data File --------------------------->
  264.  
  265.      The number of "Lag" days, or the number of days BEFORE the current day,
  266.      used to compute the average is variable.  Some people like it one way,
  267.      some like it another.  Therefore, it is also user-definable.  You may set
  268.      the number of "Lag" days to any value between 1 and the number of days in
  269.      the period by pressing the [L] key and entering the desired number of
  270.      days.  The program will use this value as it's lag value.  The number of
  271.      days in the period minus this value will be the number of days AFTER the
  272.      current day used to calculate the average.  In other words, if you want
  273.      the average to be based on the PREVIOUS 27 days plus the current day,
  274.      enter 28 as the lag value. If you want the average to be based on the
  275.      previous 13 days plus the current day, and the following 14 days
  276.      (assuming a 28 day averaging period) enter 14.
  277.  
  278.      Now, since the averaging period has a certain number of LAG and LEAD
  279.      days, the first part of the file and the last part of the file will not
  280.      have an average since part of the data required to calculate the averages
  281.      is not there.  If you need the previous 14 days to calculate an average,
  282.      the first day in the file doesn't have 14 days previous.  Likewise, if
  283.      you need 14 days past the current day to calculate the average the last
  284.      day in the file doesn't have them.  So what do you do about it?  One
  285.      recommendation is to just not display this data since anything there
  286.      would not be a correct average.  Personally, I prefer to see a cumulative
  287.      average up to the point where the moving average can take over.  The
  288.      choice is yours.  If you want to see the cumulative average, it is there,
  289.      displayed in WHITE instead of the normal color.  If you don't want to see
  290.      the cumulative averages, they can be turned off with the [C] key.
  291.  
  292.         ┌──────────────────────────────────────────────────────────────┐
  293.         │                    Data File Structure                       │
  294.         └──────────────────────────────────────────────────────────────┘
  295.  
  296.      The data that is displayed graphically is stored in a data file on disk.
  297.      By default this file is named GRAPH.DAT but you can name the file
  298.      anything that you want to.  You may want to have a file for each year,
  299.      such as GRAPH.92 or PFB.93 or whatever you decide.  To run the program
  300.      with a file different from the default, just supply the file name on the
  301.      command line when you start the program.
  302.  
  303.      Examples ... C>GRAPH .......... Starts the program using GRAPH.DAT
  304.                   C>GRAPH PFB.93 ... Starts the program using PFB.93
  305.  
  306.      The structure of the data file is simple.  It is just an ASCII file that
  307.      may be edited with any text editor.  Don't use a word processor unless
  308.      you can do so in ASCII mode since most word processing software puts
  309.      special control characters in the file that would not be understood by
  310.      this software.
  311.  
  312.  
  313.  
  314.  
  315.  
  316.                                    Page 5
  317.  
  318.         ┌──────────────────────────────────────────────────────────────┐
  319.         │                       Data File Syntax                       │
  320.         └──────────────────────────────────────────────────────────────┘
  321.  
  322.      The data file contains three columns of data, all three of which are
  323.      taken from Tad Cook's Propagation Forecast Bulletin.  The first is the
  324.      date, second is the sunspot value, and third is the 10.7cm Solar Flux
  325.      value.  Here are some examples:
  326.  
  327.      04/19/91    152   229.0
  328.      04/20/91    122   201.0
  329.      04/21/91     92   180.0
  330.      04/22/91     73   166.0
  331.      05/20/93     48    91.1
  332.      05/21/93     34    91.0
  333.      05/22/93     22    91.8
  334.  
  335.      Notice that the values are right-justified with the columns, or when the
  336.      sunspot or solar flux values are less than 100, the right-most characters
  337.      line up.  The date starts in column 1.  The sunspot value starts in
  338.      column 13, and the solar flux value in column 19. If you use the supplied
  339.      data file as an example, you won't have any trouble.
  340.  
  341.         ┌──────────────────────────────────────────────────────────────┐
  342.         │                            Summary                           │
  343.         └──────────────────────────────────────────────────────────────┘
  344.  
  345.      That's about it.  As I said, the program is easy to use, and not too
  346.      fancy.  I wrote it initially for my own use, but at the request of Tad
  347.      Cook, I decided to let it become available to anyone that wants a copy.
  348.  
  349.      If you want to pass it on to someone else, please feel free to.  While I
  350.      retain the copyright on the software, I do release it for NOT-COMMERCIAL
  351.      and NON-PECUNIARY distribution as long as the all program, data and help
  352.      files are transferred together and in an unmodified and unaltered state.
  353.  
  354.      If you have problems or comments about the program, I'd love to hear from
  355.      you.  My address is correct in the 1988 or later callbook or as follows:
  356.  
  357.     Scott Craig - WA4TTK
  358.     409 Jessie Drive
  359.     Nashville, TN 37211
  360.  
  361.     WA4TTK @ KC4PRD.TN.USA.NOAM  (All Packet Mail)
  362.     WA4TTK @ AA4DO.TN.USA.NOAM   (Southeast US DX PacketCluster Address)
  363.  
  364.      Please include the version number from your copy of the program.  It can
  365.      be found on the first screen when the program is started.
  366.  
  367.      We all owe Tad Cook (KT7H) a vote of thanks for the Propagation Forecast
  368.      Bulletins he writes each week.  Speaking for myself, I enjoy reading
  369.      them, and look forward to them every week.  I also owe him a big Thank
  370.      You for his help in the writing of this program.  We have communicated
  371.      several times via Packet Mail, and his input has helped make this program
  372.      much more useful.
  373.  
  374.      Thanks also go out to Joel - AA5YA for his help in reformatting my HELP
  375.      file into this nice documentation file, and Syd - VE3EGO for compiling
  376.      the 1989 through 1991 Solar Flux data.  I really appreciate their help!
  377.  
  378.      73's ... Scott Craig ... WA4TTK ...
  379.      
  380.      
  381.