Source Code for Package wiat

 1  # Copyright 2008 Antoine Lefebvre 
 2  # 
 3  # This file is part of "The Wind Instrument Acoustic Toolkit". 
 4  # 
 5  # "The Wind Instrument Acoustic Toolkit" is free software: 
 6  # you can redistribute it and/or modify it under the terms of 
 7  # the GNU General Public License as published by the 
 8  # Free Software Foundation, either version 3 of the License, or 
 9  # (at your option) any later version. 
10  # 
11  # "The Wind Instrument Acoustic Toolkit" is distributed in the hope 
12  # that it will be useful, but WITHOUT ANY WARRANTY; without even 
13  # the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
14  # See the GNU General Public License for more details. 
15  # 
16  # You should have received a copy of the GNU General Public License 
17  # along with "The Wind Instrument Acoustic Toolkit". 
18  # If not, see <http://www.gnu.org/licenses/>. 
19  # 
20  # All rights reserved. 
21   
22  """ B{The Wind Instrument Acoustic Toolkit} 
23       
24      U{http://www.music.mcgill.ca/musictech/caml/wiat/} 
25   
26      This toolkit consists of a package of computer programs useful for 
27      researchers in wind instrument musical acoustics and eventually, the  
28      wind instrument designer as well. It includes both simulation and  
29      measurement capabilities. Researchers from musical acoustics laboratories  
30      around the world are invited to collaborate in its development to keep it  
31      up to date with the latest theoretical results. The capabilities of the  
32      software include: 
33   
34          1. the calculation of linear input impedance from a geometry definition  
35             using either a one-dimensional transmission-matrix (TM) method or  
36             multimodal method (MM); 
37   
38          2. optimization routines for the design of wind instrument prototypes;  
39   
40          3. processing of measurement data for comparison with simulation  
41             results;  
42    
43          4. automatic generation of reports for easy incorporation into  
44             publications and/or web sites. 
45           
46      Other suggestions are welcome. 
47   
48      Important notes: 
49          - Dimensions are in meters.  
50   
51      To get started, you can look at the Examples directory. 
52   
53  """ 
54   
55  __version__ = "0.1.0" 
56  __author__ = "Antoine Lefebvre" 
57  __credits__ = "Thanks to the U{FQRNT<http://www.fqrnt.gouv.qc.ca/>} for"+\ 
58          " financing my doctoral studies." 
59  __license__ = "GPLv3" 
60   
61  import wiat.Plot 
62  import wiat.Reports 
63  import wiat.Data 
64  import wiat.util 
65  import wiat.TM 
66  import wiat.MM 
67  import wiat.instruments 
68   
69  __all__ =  ['TM', 'MM', 'instruments'] 
70   
71  import os 
72  BEMDIR = os.path.join(os.path.dirname(__file__), 'data', \ 
73      'BEM simulation results') 
74  MEASUREMENTDIR = os.path.join(os.path.dirname(__file__), 'data', \ 
75      'Impedance measurement data') 
76  del os 
77