tomwalters@0: AIM R7 tomwalters@0: tomwalters@0: The current release of AIM is R6.22. The appropriate files are README tomwalters@0: and aim.tar.Z. tomwalters@0: tomwalters@0: Sometime over the next few months a Letter to the Editor will appear tomwalters@0: in JASA announcing a software package for Time-Domain Modelling of tomwalters@0: Peripheral Auditory Processing. It is based on AIM Release 7 which tomwalters@0: will be released at the time the Letter to the Editor appears. There tomwalters@0: are no changes to the first two stages of AIM (the bmm and nap tomwalters@0: stages); improvements have been made to the third stage (sai) but they tomwalters@0: only affect exotic stimuli like damped and ramped sounds. Most users tomwalters@0: would not notice the differences. tomwalters@0: tomwalters@0: In preparation for the new release, we have set up a WWW page that tomwalters@0: directs readers to this file (ReadMe.First) and AIM R7. The release tomwalters@0: contains an alot of new documentation on all stages of AIM. We are tomwalters@0: setting the new system up now and so pieces of it may appear in this tomwalters@0: directory. tomwalters@0: tomwalters@0: The new release of AIM is R7.0. The appropriate files are ReadMe.First tomwalters@0: (this file) and aimR7.tar.Z. You are welcome to take them, but the tomwalters@0: ReadMeFirst file may not describe AIM R7 correctly in all details at tomwalters@0: this point in time. tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: AUDITORY IMAGE MODEL (AIM) SOFTWARE PACKAGE tomwalters@0: tomwalters@0: Medical Research Council, tomwalters@0: Applied Psychology Unit tomwalters@0: Cambridge, CB2 2EF, UK tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: This file contains: tomwalters@0: tomwalters@0: 1. General information: tomwalters@0: A. Disclaimer and copyright. tomwalters@0: B. Acknowledgements. tomwalters@0: C. Contact addresses. tomwalters@0: D. Ftp instructions for obtaining the software. tomwalters@0: tomwalters@0: 2. Getting started: tomwalters@0: A. Installing the software [compilation]. tomwalters@0: B. Running the model. tomwalters@0: C. Setting the environment variables PATH and the MANPATH. tomwalters@0: tomwalters@0: 3. Compiling the model - further details. tomwalters@0: A. X11 libraries. tomwalters@0: B. Alternative compilers. tomwalters@0: C. A note on color workstations. tomwalters@0: tomwalters@0: 4. Next step after installing AIM. tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: 1. GENERAL INFORMATION: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: A. Disclaimer and Copyright tomwalters@0: tomwalters@0: Permission to use, copy, modify, and distribute the software described in tomwalters@0: this document without fee is hereby granted for research purposes, provided tomwalters@0: that this copyright notice appears in all copies and in all supporting tomwalters@0: documentation, and that the software is not redistributed for any fee tomwalters@0: (except for a nominal shipping charge). Anyone wanting to incorporate all or tomwalters@0: part of this software in a commercial product must obtain a license from the tomwalters@0: Medical Research Council. tomwalters@0: tomwalters@0: The MRC makes no representations about the suitability of the software tomwalters@0: described in this document for any purpose. It is provided `as is' without tomwalters@0: express or implied warranty. tomwalters@0: tomwalters@0: The MRC disclaims all warranties with regard to this software, including all tomwalters@0: implied warranties of merchantability and fitness. In no event shall the tomwalters@0: MRC be liable for any special, indirect or consequential damages or any tomwalters@0: damages whatsoever resulting from loss of use, data or profits, whether in tomwalters@0: an action of contract, negligence or other tortious action, arising out of tomwalters@0: or in connection with the use or performance of this software. tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: B. Acknowledgements tomwalters@0: tomwalters@0: The AIM software was developed for Unix workstations by John tomwalters@0: Holdsworth and Mike Allerhand of the MRC APU, under the direction of tomwalters@0: Roy Patterson. The physiological version of AIM was developed by tomwalters@0: Christian Giguere. The options handler is by Paul Manson. The revised tomwalters@0: SAI module is by Jay Datta. Michael Akeroyd extended the postscript tomwalters@0: facilites and developed the xreview routine for auditory image tomwalters@0: cartoons. tomwalters@0: tomwalters@0: The project was supported by the MRC and grants from the U.K. Defense tomwalters@0: Research Agency, Farnborough (Research Contract 2239); the EEC Esprit tomwalters@0: BR Porgramme, Project ACTS (3207); and the U.K. Hearing Research Trust. tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: C. Contact Addresses. tomwalters@0: tomwalters@0: Roy D Patterson, Mike Allerhand, Michael Akeroyd, Jay Datta tomwalters@0: MRC APU, 15 Chaucer Road, Cambridge CB2 2EF, England. tomwalters@0: Phone +44 1223 355294 tomwalters@0: Fax +44 1223 359062 tomwalters@0: tomwalters@0: Christian Giguere tomwalters@0: email: c.giguere@med.ruu.nl tomwalters@0: tomwalters@0: ASSISTANCE: tomwalters@0: tomwalters@0: email: Mike.Allerhand@mrc-apu.cam.ac.uk (Software support) tomwalters@0: Roy.Patterson@mrc-apu.cam.ac.uk (Auditory modelling) tomwalters@0: Michael.Akeroyd@mrc-apu.cam.ac.uk (Modelling and graphics) tomwalters@0: Jay.Datta@mrc-apu.cam.ac.uk (Software and documentation) tomwalters@0: c.giguere@med.ruu.nl (tlf, meddis, aimlinux) tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: D. ftp Instructionsu for Obtaining the Software tomwalters@0: tomwalters@0: Access to the APU site via ftp is by the address: tomwalters@0: ftp.mrc-apu.cam.ac.uk Use ="anonymous" and =your email tomwalters@0: address. Once inside the APU ftp system, cd to the AIM directory, tomwalters@0: pub/aim/. The AIM software is in the compressed archive `aim.tar.Z'. tomwalters@0: The ReadMe.First file contains the text of this document. Copy both. tomwalters@0: tomwalters@0: For example: tomwalters@0: tomwalters@0: ftp ftp.mrc-apu.cam.ac.uk tomwalters@0: tomwalters@0: Name (mrc-apu.cam.ac.uk:you): anonymous tomwalters@0: Password: your email address tomwalters@0: tomwalters@0: cd pub/aim tomwalters@0: tomwalters@0: get aim.tar.Z tomwalters@0: get ReadMe.First tomwalters@0: tomwalters@0: tomwalters@0: Details of machine and address tomwalters@0: tomwalters@0: Name: sirius.mrc-apu.cam.ac.uk tomwalters@0: Address: 192.18.195.1 tomwalters@0: Aliases: dns0.mrc-apu.cam.ac.uk tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: 2. GETTING STARTED: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: A. Installing the Software tomwalters@0: tomwalters@0: It is best to make a new directory (e.g. aim) for the software. Put tomwalters@0: aim.tar.Z and ReadMe.First in the directory and unpack the source code tomwalters@0: using the command: tomwalters@0: tomwalters@0: zcat aim.tar.Z | tar xvf - tomwalters@0: tomwalters@0: The current directory should then contain a makefile and a set of tomwalters@0: subdirectories. Five of these contain the C source code for AIM tomwalters@0: (filter, glib, model, stitch, and wdf). The tools directory contains C tomwalters@0: code for ancillary routines to construct stimuli and process the tomwalters@0: multi-channel output that AIM produces. The man directory contains tomwalters@0: online manual pages available through MANPATH and the instruction tomwalters@0: 'manaim'. The scripts directory contains guided tours of AIM in the tomwalters@0: form of scripts that also serve to test the installation and tomwalters@0: illustrate a typical mode of operation. The waves directory contains tomwalters@0: test waves demonstration waves including 'hat'. These sounds were all tomwalters@0: sampled at 20 kHz and each sample is a 2-byte word in little-endian tomwalters@0: order (i.e. Dec and PC order). The bytes need to be reversed for tomwalters@0: Sun, HP and SGI machines. The bin directory contains executable routines tomwalters@0: and links to executable routines produced by the compilation. tomwalters@0: tomwalters@0: tomwalters@0: Compile the source code using tomwalters@0: tomwalters@0: make tomwalters@0: tomwalters@0: where: = decstation | vax | sun | sungcc | hp | linux tomwalters@0: (For other options see: "Compiling the model - further details") tomwalters@0: The file `gen' is the AIM program itself. tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: B. Running the model. tomwalters@0: tomwalters@0: tomwalters@0: To verify that AIM is operational, move to the bin directory and type: tomwalters@0: tomwalters@0: gen -help tomwalters@0: tomwalters@0: This should print general usage information on the standard output. tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: C. Setting Up the Environment Variables PATH and MANPATH. tomwalters@0: tomwalters@0: tomwalters@0: The software is now ready. Before setting off, however, we recommend tomwalters@0: that you tomwalters@0: tomwalters@0: a) Set your PATH to include [aim_directory]/bin tomwalters@0: (instructions in docs/aimPaths) tomwalters@0: b) Set your MANPATH to include [aim_directory]/man tomwalters@0: (instructions in docs/aimPaths) tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: 3. COMPILING THE MODEL - FURTHER DETAILS. tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: In the root directory, the command "make help" prints a list of the tomwalters@0: targets and parameters for compilation. The machine-specific details tomwalters@0: refer only to the location of the X11 libraries and header files on tomwalters@0: the target machine. tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: A. X11 Libraries tomwalters@0: tomwalters@0: The AIM graphics library is based upon X11, and the library (libX11.a) and tomwalters@0: included header files (X11/X.h and X11/Xlib.h) are expected to be in tomwalters@0: standard places. The command "make " assigns the paths usually used tomwalters@0: on the particular machine. tomwalters@0: tomwalters@0: For example, the command tomwalters@0: tomwalters@0: make decstation tomwalters@0: tomwalters@0: assigns paths so that the following files are expected: tomwalters@0: tomwalters@0: /usr/lib/libX11.a tomwalters@0: /usr/include/X11/X.h tomwalters@0: /usr/include/X11/Xlib.h tomwalters@0: tomwalters@0: If the X11 library and header files are in non-standard directories, tomwalters@0: then the path for the directories can be given to the root makefile tomwalters@0: using the parameters X11DIR (for the directory containing the files tomwalters@0: files X11/X.h and X11/Xlib.h) and X11LIB (for the directory containing the tomwalters@0: library libX11.a). These parameters override the default parameters assigned tomwalters@0: for a particular machine. tomwalters@0: For example decstation paths could also be assigned using:- tomwalters@0: tomwalters@0: make X11DIR=/usr/include X11LIB=/usr/lib [] tomwalters@0: tomwalters@0: sun paths could also be assigned using:- tomwalters@0: tomwalters@0: make X11DIR=/usr/openwin/include X11LIB=/usr/lib [] tomwalters@0: tomwalters@0: To see what the internal defaults are for a particular machine, type: tomwalters@0: tomwalters@0: make TARGET=help tomwalters@0: tomwalters@0: This prints a complete list of the makefile targets, arguments, and defaults tomwalters@0: on the standard output. The values of the arguments X11DIR and X11LIB are tomwalters@0: the default paths associated with the specified machine. tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: B. Alternative compilers tomwalters@0: tomwalters@0: The default compiler is the traditional C compiler cc. tomwalters@0: Alternative compilers can be specified by giving the name of the compiler to tomwalters@0: the root makefile, (assuming it exists in the current path). tomwalters@0: For example, the GNU Project C compiler, gcc, is specified as follows, tomwalters@0: (including it's -ansi flag, for compatability with ansi cc): tomwalters@0: tomwalters@0: make CC=gcc CFLAGS="-O -ansi" tomwalters@0: tomwalters@0: We find following produces code which runs significantly faster that the tomwalters@0: traditional cc compiler: tomwalters@0: tomwalters@0: make CC=gcc CFLAGS=-O2 tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: C. A Note on Color Workstations tomwalters@0: tomwalters@0: The AIM software X11 interface is designed for monochrome screens, and tomwalters@0: not for multiplane color screens. The software will run on a color tomwalters@0: screen, except that when bitmaps are created they are the same depth tomwalters@0: as the screen, since they are exact copies of the screen memory. tomwalters@0: This also happens, for example, when the "animate" option is on, or tomwalters@0: when the "xreview" program is used. The symptoms are a very slow tomwalters@0: response time, and huge bitmap files. tomwalters@0: tomwalters@0: There is a hidden option "mono=on" (short for "monochrome") which tomwalters@0: forces the bitmap to be a single plane of the screen memory. By tomwalters@0: default, it copies plane 1; if this does not work, the plane can be tomwalters@0: varied with the hidden option "planemask=". tomwalters@0: tomwalters@0: Any queries to: tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: ============================================================================ tomwalters@0: 4. Next step after installing AIM. tomwalters@0: ============================================================================ tomwalters@0: tomwalters@0: tomwalters@0: When the installation is complete go to the 'bin' directory. It tomwalters@0: contains the compiled programs and the user ReadMe file which is the tomwalters@0: start point for the user documentation. bin/ReadMe provides an tomwalters@0: overview of AIM, a set of demonstrations, an overview of the AIM tomwalters@0: documentation, and PATH information. tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: tomwalters@0: