PDS_VERSION_ID          = PDS3
RECORD_TYPE             = STREAM
LABEL_REVISION_NOTE     = "
C. Piker (U. Iowa) 2018-09-07; Removed JAVA App, using Autoplot vap links"
OBJECT                  = TEXT
  PUBLICATION_DATE        = 2018-09-07
  NOTE                    = "
    SOFTINFO.TXT describes the contents of this directory."
END_OBJECT              = TEXT
END

This directory contains files related to example software applicable to
the data on this volume.  All code and files are provided "as is"
without any warranty but with the hope that they will be useful in
understanding the data provided on this volume.  These supplemental
files are beyond PDS archiving requirements and may not meet PDS
standards.

[SOFTWARE]              This directory
 |
 |- SOFTINFO.TXT        Description of and instructions for software in
 |                      this directory.  (this file)
 |
 |- [C]                 Directory containing C example code
 |   |
 |   |- TESTIN.LBL      Test waveform data file and associated label for
 |   |- TESTIN.DAT      the VGPWS_WF_LIST program.
 |   |
 |   |- TESTOUT.TXT     Test output for the VG1PWS_WF_LIST program.
 |   |
 |   |- VGPWS_WF_LIST.C Complete application for printing Voyager PWS
 |   |                  waveform samples as hexidecimal values.
 |   |
 |   |- VGPWS_WF_LIST.MAK
 |   |                  Makefile for compiling and testing
 |   |                  VGPWS_WF_LIST.C on POSIX compliant operating
 |   |                  systems
 |   |
 |   |- WFENGHDR.FMT    Format details of the TESTIN.DAT file header
 |   |
 |   |- WFROWPFX.FMT    Format details of the TESTIN.DAT record header
 |
 |
 |- [IDL]               Directory containing the VGPWS_WF_PLOT data
     |                  viewer
     |
     |- VGPWS_WF_PLOT.PRO
                        Example IDL program to extract Voyager PWS
                        waveform samples and plot the waveform and
                        relative power spectrum.
  


VGPWS_WF_LIST.C example C code
==============================

  The file VGPWS_WF_LIST.C contains example C code for a complete program
  to read and list data from Voyager 1 and Voyager 2 PWS waveform reciever
  archive files.

  In order to compile and test the example, you will need to copy
  all of the files in the EXTRAS/SOFTWARE/C directory to a writable
  directory.  For POSIX development environments, a makefile is provided
  to automate the creation and verification of the two executable
  programs.  To use the makefile (in the writable directory):

  % make -f VGPWS_WF_LIST.MAK

  If there are no compilation errors, then

  % make -f VGPWS_WF_LIST.MAK test

  The last 2 lines printed should indicate whether the executable was
  verified to be working correctly or not.


  Compile and Test Details
  ------------------------
  In case the makefile cannot be used, the details of compilation and
  testing are as follows on POSIX systems:

  In order to compile this code on POSIX systems, it may be necessary to
  rename the file and remove the CR character from the CRLF line
  termination.  Note that gcc does not require this step.

  % tr -d \\r < VGPWS_WF_LIST.C > vgpws_wf_list.c

  On systems with the gnu compiler tools the compile may be as simple as

  % gcc -O -o vgpws_wf_list vg1pws_wf_list.c

  The executables should be used to generate the output file verify.txt
  from the provided input data file:

  % vg1pws_wf_list < TESTIN.DAT > verify.txt

  Finally the newly created output file should be compared against the
  provided output file:

  % diff TESTOUT.TXT verify.txt

  If there are no differences, then your compiled example should be
  working correctly.


VGPWS_WF_PLOT.PRO example IDL code
==================================

  The file VGPWS_WF_PLOT.PRO contains example IDL code for an application
  to read and plot data from the binary archive files.  The application
  will prompt for a file name and then step through all available
  samples, showing the waveform and relative power spectrum for each
  line.

=========================================================================