Time-Domain Model of Cochlear Mechanics			September 2004

The files in this directory contain source code for a time-domain model
of cochlear mechanics called "tdm".  This program currently runs under
Linux (either with or without X window) and under MS Windows (as a
console application). The Windows verson requires the DJGPP compiler
Both versions require the GRX library for graphics, but can be compiled
without graphics.

Although the "tdm" program can produce a graphical display of basilar
membrane displacements, it's primary use is to create binary data files
for subsequent plotting or analysis.  In addition to the "tdm" program the
source code builds several companion programs that are used to display,
analyze, and manipulate the "tdm" data files:

    dspsta - display (graphically) the contents of a tdm "state" file
    tlook - display (graphically) the contents of a tdm data file
    reor - reorder the time-step data to be functions of time
    wrparm - write the parameters contained in the data file header
    pwrflo - compute power-flow in specially formatted tdm data files
    cvtpar - convert from old-style to new-style parameters

Makefiles for both Windows (makefile.djc) and Linux (makefile.lnx)
are included. Before typing "make", run the "configure" script in this
directory to install the appropriate makefile.

Model parameters are provided for a "cat" cochlea (cat.par) and a "human"
cochlea (man.par).  The name of the parameter file is specified on the
command line when running the program.  For example, "tdm cat" or "tdm
man".  The program execution can be interrupted at any time by typing
"Ctrl-C".  When the program is interrupted in this manner the current
"state" of the model is saved in a disk file. This allows computation to
be continued at a later time without any loss of progress.  The "state"
is also saved automatically every 5 minutes as a precaution against
computer failures.  The computation is resumed from the saved state when
the "tdm" program is started without specifying a parameter file on the
command line.

The "tdm" program also has a few command line options, which can be
listed by typing "tdm -h".  For example, "tdm -g" will enable the
graphical display of BM displacement during computation. 

The "tdm" program implements time-step solution of a nonlinear, active
model of cochlear mechanics.  The solution methods are described in my
unpublished "Notes on Cochlear Mechanics".  Results from model
computations have been presented at each of the "Mechanics of Hearing"
meetings since 1988 and published in the proceedings of those meetings. 
