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