


                     _/_/_/_/         _/_/         _/_/_/_/
                    _/      _/       _/ _/        _/      _/
                   _/      _/       _/  _/       _/
                  _/      _/       _/   _/       _/
                 _/_/_/_/         _/_/_/_/        _/_/_/
                _/      _/       _/     _/             _/
               _/      _/       _/      _/             _/
              _/      _/       _/       _/    _/      _/
             _/_/_/_/         _/        _/     _/_/_/_/


                   BAVARIAN ARCHIVE FOR SPEECH SIGNALS 

               University of Munich, Institut of Phonetics
               Schellingstr. 3/II, 80799 Munich, Germany
                      bas@phonetik.uni-muenchen.de


  COPYRIGHT Florian Schiel, University of Munich 1998. All rights reserved.   
    This corpus and software may not be disseminated further - not even
      partly - without a written permission of the copyright holders.  

                      Additional Copyright Holders

----------------------------------------------------------------------

Munich AUtomatic Segmentation (MAUS)

BAS Distribution Package   MAUS 

2003-08-19 / 2017-01-13

----------------------------------------------------------------------

INSTALLATION LINUX

1. Be sure that 'awk' is installed on your PC. To test type in:

% awk -f cccc

If you get the following output:

awk: fatal: can't open source file `cccc' for reading

then awk is installed on your computer

2. Install the newest HTK tool kit from http://htk.eng.cam.ac.uk/
To test it, simply type in:

% HVite

If an extensive help message appears, everything is fine.
If not, you'll probably have to set some enviroment variables; 
follow the instructions in the installation procedure of HTK
The package includes two Linux binaries HVite and HCopy needed by the 
maus tool; you might try iof these work on your installation:
cd <installation dir>
./HVite

3. If you intend to use WAV audio files with maus, you'll also need
to install the pubic domain tool 'sox':
 http://sox.sourceforge.net/

4. Select a directory where you want MAUS to reside in, e.g. 
/home/schiel/MAUSTOOL

5. Change into this directory 

% cd /home/schiel/MAUSTOOL

and type in: 

% tar xzf maus-<date>.tgz

The package should install itself in the directory then. To check type in:

% ls

and you should get something like (changes a lot from version to version):

CHECK                         OLDVERSIONS      PARAM.mlt
check_param_sets              OTHERTOOLS       PARAM.mlt-MT
chunker                       par2emu          PARAM.nld
Chunker                       par2emu1.awk     PARAM.nld-NL
clean                         par2emu2.awk     PARAM.pol
correctusetrn.awk             par2TextGrid     PARAM.pol-PL
create_kan                    PARAM            PARAM.por
DOCU                          PARAM.cat        PARAM.por-PT
EXAMPLES                      PARAM.cat-ES     PARAM.rus
finalusetrn.awk               PARAM.deu        PARAM.rus-RU
GRAPHINVENTAR.srt             PARAM.deu-DE     PARAM.sampa
graphvis                      PARAM.ekk        PARAM.SAMPA
graphvis.src                  PARAM.ekk-EE     PARAM.spa
HCopy                         PARAM.eng        PARAM.spa-ES
HHEd                          PARAM.eng-AU     PARAM.spa-ES.version3.2
HMM                           PARAM.eng-GB     README
HVite                         PARAM.eng-NZ     rec2mau.awk
ipkclib                       PARAM.eng-US     relaxMinDur.hed
kan2hmm.awk                   PARAM.fin        test_annot.json
kan2mlf.awk                   PARAM.fin-FI     test.csv
mau2hmm.awk                   PARAM.fra        test.EMU
mau2TextGrid.awk              PARAM.fra-FR     test.hlb
mau2TextGridORT.awk           PARAM.gsw        test.mau
mau2TextGridORT.awk.20150713  PARAM.gsw-CH     test.par
maus                          PARAM.gsw-CH-BE  test.PAR
mausbpf2emuR                  PARAM.gsw-CH-BS  test.phonetic
mausbpf2emuR_0.awk            PARAM.gsw-CH-GR  test_silenceModelling.par
mausbpf2emuR_1.awk            PARAM.gsw-CH-SG  test_silenceModelling.wav
mausbpf2emuR_2.awk            PARAM.gsw-CH-ZH  test.TextGrid
mausbpf2emuR_3.awk            PARAM.hun        test.wav
mausbpfDB2emuRDB              PARAM.hun-HU     txt2par
maus.corpus                   PARAM.ita        wav2trn
maus.iter                     PARAM.ita-IT     wav2trn.src
MAUSOUTPUT_DBconfig.template  PARAM.jpn-JP     WebMAUSInfo.txt
maus.trn                      PARAM.kat        word_var-2.0
maus.trn.awk                  PARAM.kat-GE     word_var.src
maus.web                      PARAM.MAN        xpath

6. Use your favourite editor to edit the scripts 
maus, par2TextGrid, mausbpfDB2emuRDB. 
Change the parameter 'TEMP' to a directory where MAUS may store temporary
and intermediate files.
Do the same in the scripts maus.corpus, maus.iter, maus.trn,
if you plan to use them.

7. To test the maus tool type in:

% ./maus OUT=test.TextGrid OUTFORMAT=TextGrid SIGNAL=test.wav BPF=test.par

where test.wav is some mono speech file and test.par is a matching BPF file
with at least the tier KAN.
If no error messages appear and in the directory there is a new praat file 
'test.TextGrid', everything seems to work.

That's it.

For problems contact: schiel@bas.uni-muenchen.de

Note that the text-only input option of MAUS will not work in the distribution
since the BALLOON package needed to create the German canonical pronunciation 
is not part of the MAUS free-ware package. Therefore the input alway MUST 
contain a canonical pronunciation (a KAN tier in the BPF input file).

--------------------------------------------------------------------------

INSTALLATION WINDOWS

Best way is probably to get cygwin and install/test for the same tools as 
described above for Linux (awk,csh,sox,HVite). Then try to compile the C++ 
tools graphvis (not essential) and word_var-2.0 (essential) on your Win OS.
You will need the header file ipkclib.h and the library libipkclib.a 
found in the subdir ipkclib.

If the compilation of word_var-2.0 fails on your platform, you might
consider running maus with the option CANONLY=yes. That way maus will
perform a segmentation according to the given phonemic transcript and 
not try to calculated alternative pronunciation variants. Technically
this means that word_var-2.0 is not called by the script, and therefore
you can run maus with that binary.

Good luck!
I do not give any support for the usage of MAUS under Windows. Sorry.

--------------------------------------------------------------------------

INSTALLATION MAC

People have tries to run maus on MacOS X but failed to compile the 
C++ binary word_var-2.0.
If the compilation of word_var-2.0 fails on your platform, you might
consider running maus with the option CANONLY=yes. That way maus will
perform a segmentation according to the given phonemic transcript and
not try to calculated alternative pronunciation variants. Technically
this means that word_var-2.0 is not called by the script, and therefore
you can run maus with that binary.

Good luck!
I do not give any support for the usage of MAUS under MacOS. Sorry.

