diff docs/aimDocumentation @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/aimDocumentation	Fri May 20 15:19:45 2011 +0100
@@ -0,0 +1,144 @@
+docs/aimDocumentation
+
+
+		OVERVIEW OF AIM DOCUMENTATION
+
+
+An introduction to the Documentation for the Auditory Image Model of
+Peripheral Auditory Processing
+
+
+A. Initial Contact Points and Aquisition of the Software Package
+
+
+1. WWW Page. 
+
+   Address:   http://www.mrc-apu.cam.ac.uk/aim/
+
+   An overview of AIM on the internet with facilities for acquiring
+   the software package. The text is stored in aim_html/index.html.
+
+
+2. Journal reference. 
+
+   The software package is described in a recent article entitled
+
+   "Time-domain modelling of peripheral auditory processing:
+	A modular architecture and a software platform"
+
+   by Roy D. Patterson and Mike H. Allerhand and Christian Giguere,
+   Journal of the Acoustical Society of America, 98, 1995 (in press).
+
+   The text of the article is stored in  aim/docs/PAG95.doc
+
+
+3. ftp instructions:
+
+   The instructions for obtaining AIM by ftp are stored in
+   aim/docs/ftp.doc
+
+
+
+B. Installation and Test
+
+1. ReadMe.First
+
+   This document is in top directory of aim when the aim.tar file is
+   unpacked.  It contains the instructions for compiling AIM, testing
+   the installation, and setting up paths to the instructions, the
+   aimtools, and the online documentation (manual pages accessed
+   through 'manaim').
+
+
+
+C. Introduction to the Operation of AIM
+
+
+1. bin/ReadMe
+
+   This is the initial ReadMe file for those wanting to use AIM once it
+   has been installed and tested. It begins with a guided tour of AIM and
+   then describes the user documentation and where to find it. 
+
+
+2. Introduction to AIM instructions:   docs/aimInstructions
+
+   An introduction to the instructions and command-line options used to
+   control the auditory model is stored in  docs/aimInstructions.
+   The instructions have the form gen???. The command 'gen -help | more'
+   lists the three letter combinations that may replace ??? and
+   briefly describes the operations they invoke.
+
+
+3. AIM on-line help:	gen??? -help
+
+   The instruction 'gen -help | more' lists the AIM instructions.
+
+   The instructions have the form 'gen??? -options <file_name>'.
+
+   The final three letters of the AIM instruction specify the point
+   in the system where the user chooses to observe the output.
+   Instructions of the form 'gen??? -help' cause AIM to list the
+   options that control AIM up to that output point along with a brief
+   description of the option and its current and default value.
+
+
+4. Manual pages for AIM instructions:	manaim gen???
+
+   The documentation for each instruction and its options is
+   provided in standard manual pages accessed by instructions of the
+   form 'manaim gen???'.  Begin with 'manaim genwav' which describes
+   non-auditory options such as those for the AIM display and for
+   the input and output files.
+
+   A complete listing of the AIM instructions is included in the listing
+   produced by the instruction 'manaim -k all | more'.
+
+   Manual pages can be printed with commands of the form
+   'manaim gen??? | lpr'.
+
+
+5. Manual pages for AIM tools:	 manaim <aimtool_name>
+
+   The software package includes a set of 'aimtools' for generating
+   and manipulating input waves, and for processing the multi-channel,
+   multi-frame output of AIM.
+
+   There are manual pages for the aimtools accessed by instructions of
+   the form 'manaim <aimtool_name>'.
+
+   A complete listing of the aimtools is included in the listing
+   produced by the instruction 'manaim -k all | more'.
+
+
+
+D. Additional Facilities
+
+
+1. Silent Options: 	docs/aimSilentOptions
+
+   AIM includes a number of 'silent options' that are occassionally
+   useful but not sufficiently important to warrant positions on the
+   options lists produced by the on-line help (gen??? -help).
+
+   A list of the silent options is provided in docs/aimSilentOptions
+
+
+2. File Formats: 	docs/aimFileFormats
+
+   A description of the layout of information in the output files
+   produced by AIM is presented in docs/aimFileFormats
+
+
+
+3. AIM list: 	mail [e-mail]
+
+   An email list for AIM users has been set up. The instructions for
+   joining and retiring from the mail list are presented in
+   docs/aimMailList. 
+
+   Note that the list is not moderated. It is a facility whereby users
+   can communicate for their mutual benefit rather than a question
+   answering facility provided by the software developers.
+
+