Basic documentation

1. General information:
   • These short demo applications were developed with two ideas in mind:
     1. To illustrate the operations used in Rhythm Formant Analysis,
     2. To provide a starting point for interested persons to develop their own applications.
   • The applications were developed using Python 3.8.10 with Ubuntu Linux Ubuntu 20.04.2 LTS.
   • In principle they are also suitable for use with distributions of the same version of Python under Windows or MacOS, but this has not been tested.
2. Instructions:
   1. Download all files in this directory, including demo programs, sample input mono WAV files and their output graphics files, from this ZIP file: DemoSoftware.zip
   2. when the files have been downloaded and unzipped, check the directory structure with your file manager and compare it with the files listed at the end of this documentation file;
   3. double-click on the program file to start it, and if all is well, then a figure will pop up after a few seconds and the figure will be saved in one of the output directories;
   4. alternatively, call the programs from the command line interface (CLI).
3. Data directories:
   • Example data files for the demo programs are supplied in the directory "DATA/".
   • The example data files for the clustering applications are in a subdirectory "DATA/DATA_RT/".
   • The demo software accepts WAV mono recordings only.
4. Graphics output directories:
   • RFA analysis output figures in the directory "PNG/".
   • Distance networks output figures in the directory "DNETS/".
   • Distance-based hierarchical cluster dendrograms in directory "DGRAMS/".
5. Files:
   1. This directory: "DemoSoftware/"
   2. Input and output directories (note that output files generated by the programs are included):
      • DATA/ (for all data files)
      • DATA/DATA_RT/ (for the distance mapping and clustering files)
      • DNETS/ (for the distance network output files - output files are included)
      • DGRAMS/ (for the distance-based hierarchical clustering dendrogram output files - output files are included)
      • PNG/ (for the RFA signal processing output files in PNG format)
   3. Programs:
      • A_waveform_display.py
      • B_waveform_display.py
      • C_waveform_envelope_display.py
      • D_waveform_envelope_display.py
      • E_waveform_envelope_spectrum_display.py
      • F_waveform_envelope_spectrum_display.py
      • G_waveform_envelope_spectrum_file_outputs.py
      • H_waveform_envelope_spectrum_distance_network.py
      • I_waveform_envelope_spectrum_distance_clusters.py
      • J_waveform_envelope_F0.py
      • K_waveform_envelope_F0.py
      • L_LF_AM_spectrogram.py
      • Modules used by other programs:
        • module_drawdendrogram.py (used by L_AM_LF_spectrogram.py)
        • module_fm_demodulation.py (used by J_waveform_envelope_F0.py and K_waveform_envelope_F0.py)
        • module_spectrogram.py (used by L_AM_LF_spectrogram.py)

Listing of all files in this directory