      NTP Plotter - program to display loopstats data from ref-clocks


REGISTRATION

Not applicable


INSTALLATION AND USAGE

Copy the files from the Zip archive to a folder of your choice, such as:

  C:\Tools\SatSignal\

Windows Vista and Windows-7 users are advised to avoid using the
C:\Program Files\ directory, as non-admin user cannot write there.


SETUP

Not applicable.


OPERATION

Run the program by double-clicking, and drag-and-drop one oe more loopstats
files from Explorer onto the program.  You can also drag-and-drop a directory
containing loopstats files.  If no parameter is specified, files in the
current directory named loopstats.* are analysed.

To save the current graph images, press the Save button.  The images are named:

  _offset.png
  _offset-tod.png
  _abs-frequency.png
  _frequency.png
  _frequency-tod.png
  _jitter.png

and live in the same directory as the source data.  After saving the images, 
the program reports the names of the files sucessfully saved.  There will be 
more images should peerstats data be present.

Zoom

To zoom in on a chart, press the left mouse button at the top left hand
corner of the area you wish to zoom in on and, maintaining the mousebutton
pressed, drag out the rectangle to the bottom right hand corner of the zoom
area.  Releasing the mousebutton will force the chart to redraw the area
selected.

To undo the zoom, press the left mouse button anywhere on the chart area and
drag up and left with the mouse button depressed.  Releasing the button will
force the chart to redraw to the originally defined chart area.

Scroll

To scroll a chart across, press the right mouse button and, maintaining the
mouse button pressed, drag the mouse in the direction you wish to scroll the
chart.  When you release the mouse button the chart will remain at the new
location.


COMMAND-LINE PARAMETERS

The program will accept command-line parameters as either:

- a directory containing loopstats files
- a single loopstats file
- multiple loopstats files

Please note that loopstats files are expected to be named:

  loopstats.20111227
  loopstats.20111228

although for one user the alternative is recognised:

  loops.20111227
  loops.20111228

From program version 1.0.18, the individual files may also be in a compressed
format (Zip), containing one or more zipped loopstats files.  The Zip files
should match the naming convention above:

  loopstats.20120214.zip
  loopstats.20120215.zip

Only Zip files with loopstats at the top directory level have been tested.
Using Zip files cuts the file size down to about a quarter of the
uncompressed size.


NOTES

The program has been developed on Windows XP, and should run on Windows XP,
Vista and Windows-7.  It may work, but is not supported, on the earlier
Windows versions.


KNOWN ISSUES

None.


RELEASE INFORMATION

beta V1.0.0.001
V1.0.0  2009-Mar-13  First released version
                     Accept file or directory on the command-line
                     Accept single file or directory drag-and-drop

beta V1.0.1.010
V1.0.1  2009-Apr-23  Accept multiple files on the command-line
                     Accept multiple files via drag-and-drop
                     Allow up to a week's data (suggest not /all/ files!)
                     Add control of jitter average method and duration
                     Actual number of samples is the hint on the "Hours.." text
                     Warn if too few data points
                     Treat missing data as zero (more than 1 hour data gap)
                     Report back on image files saved
                     Scale offset and jitter plots to milliseconds if necessary

beta V1.0.2.014
V1.0.2  2009-May-23  Add user control of jitter scale
                     Recognise greater maximum offsets
                     Improved evaluation of median jitter ..
                     .. reduce the influence of many closely-timed points
                     .. only use points at least 1024s apart

beta V1.0.3.016
V1.0.3  2009-May-26  Add offset & frequency delta vs. time-of-day plots

beta V1.0.4.018
V1.0.4  2009-May-28  Correct behaviour with comma decimal separator
                     Improve visibility of multi-colour plots

beta V1.0.5.019
V1.0.5  2009-May-30  Correct axis label of jitter-vs-time-of-day

beta 1.0.6.020
V1.0.6  2009-Jun-08  Clear the "vs. time-of-day" graphs when the plot changes

beta V1.0.7.021
V1.0.7  2009-Jun-21  Build with Delphi 2009

beta V1.0.8.023
V1.0.9  2009-Aug-07  Try to open loopstats file with ShareDenyNone

beta V1.0.9.024
V1.0.9  2009-Aug-14  Add plot of absolute frequency error

beta V1.0.10.025
V1.0.10 2009-Sep-07  Add choice of white plot background

beta V1.0.12.026
V1.0.12 2009-Nov-03  Correct maximised white plot background checkbox

beta V1.0.13.027
V1.0.13 2010-Jul-03  Add RMS offset plot

beta V1.0.14.029
V1.0.14 2011-May-03  Option to start with jitter plot
                     More netbook-friendly version

beta V1.0.15.031
V1.0.15 2011-Sep-25  Be more tolerant of single file name ..
                     .. but it needs to contain "loopstats.2"
                     Default is to read loopstats file in current directory
                     F5 key refreshes the data

beta V1.0.16.037
V1.0.16 2011-Dec-28  On jitter graph ..
                     .. make left/right axis colours match the line colours
                     .. revise weighted averaged jitter
                     Align the graphs better
                     Accept loostats named loops.20111228 etc.
                     Correct typo in "Jitter first" hint
                     Correct recognition of single loopstats.2* file
                     Internally ..
                     .. correct typo in "Jitter first" hint               .032
                     .. axis labels font colour improvements              .033
                     .. weighted averaging enhancements                   .034
                     .. align the graphs better                           .035
                     .. correct recognition of single loopstats.2* file   .036
                     .. allow for loops.2* files                          .037

beta V1.0.17.040
V1.0.17 2012-Jan-31  Add option for Local time display
                     Enhanced histogram, right-click Offset vs. Date graph
                     Correct operation of F5 (refresh) for multiple files

beta V1.0.18.042
V1.0.18 2012-Feb-16  Accept Zip archive file with one or more files ..
                     .. Zip file is skipped if it has more than 7 files
                     Add program version number to window title

beta V1.0.19.054
V1.0.19 2012-Mar-25  Add support for peerstats analysis ..
                     .. includes mean, min/max & rms offsets & delays
                     .. lists and graphs sorted by number of entries
                     .. can right-click the table top copy to clipboard
                     .. table and graphs included in Save command
                     .. accept "-1d" .. "-9d" parameters for 1..7 day limit
                     .. not more than 9-day limit accepted
                     .. work in period or comma separated regions
                     Add poll-interval graph for loopstats
                     Revised layout ..
                     .. make top-level control "loopststats" and "peerstats"
                     .. unify loopstats and peerstats graph presentation
                     .. results in larger peerstats graphs
                     Auto-update option
                     Clearer zoom lines on the graphs
                     Remembers size and position between runs
                     Relax file name recognition ..
                     .. now only requires "looptstatst" or peerstats" in name
                     .. or "loops.2" or "peers.2" in the name
                     Other minor enhancements

beta V1.0.20.056
V1.0.20 2012-Apr-24  Make "plot data gaps as zero" optional

beta V1.0.21.057
V1.0.20 2012-Nov-17  Make RMS compute on hourly boundaries

beta V1.0.22.058
V1.0.22 2012-Nov-26  Accept .GZ compressed data

beta V1.0.23.059
V1.0.23 2012-Dec-10  Try harder to find files in the current directory ..
                     .. should be named loop*.2* and peer*.2*
                     If no files found display File|Open dialog
                     Option to show LAN-only peerstats, LAN defined as ..
                     .. either 192.168.x.x addresses
                     .. or 127.127.x.x addresses

beta V1.0.24.060
V1.0.24  2012-Dec-18  Add delay to plot updates when up/down is clicked ..
                      Speed up plots, partic. with many days & weighted jitter

beta V1.0.25.063
V1.0.25  2013-Oct-18  Add option to control clip of offset data ..
                      .. checked by default for better display of "spikey" data
                      Update program caption when single file dropped
                      Don't save peerstats graph images if no peerstats data

beta V1.0.26.064
V1.0.26  2013-Nov-12  Improved handling of data gaps, make them more obvious

beta V1.0.27.065
V1.0.27  2013-Nov-29  Ensure all graphs are the same size, as on the screen

beta V1.0.28.067
V1.0.28  2014-Mar-25  Accept directory names without the trailing "\"
                      Make legend text match line colour
                      If no graphs saved, suggest user check write-access


LIMITATIONS

The user of the program is responsible for ensuring the accuracy of any data
produced by the program.

Please note that the RMS offset plot is the RMS variation about the mean level,
and /not/ the variation about zero.


WARRANTY

This program is provided "as is" and without any warranty as to merchantability
or fitness for a particular purpose or any other warranties either expressed or
implied.  The author will not be liable for data loss, damages, loss of profits
or any other kind of loss while using or misusing this software.

This software may not be used in safety-critical or life-critical systems.


PROGRAM STATUS AND DISTRIBUTION

This program is copyrighted software from David J Taylor, Edinburgh and is
provided "as is".


COMMERCIAL USE

Use by any commercial organisation, or any individual for commercial purposes
requires the purchase of a commercial licence from David Taylor, Edinburgh.


ACKNOWLEDGEMENTS

To Dave Hart for his encouragement and support, and to Ron Frazier for his
suggestions and testing.


CONTACTING THE AUTHOR

Web site:  http://www.satsignal.eu
E-mail:    davidtaylor@writeme.com

2014-Mar-25