Author Archives: Maria Gouskova

Praat tutorial

Introduction

  • Praat is a freely available program written by Paul Boersma and David Weenink.
  • It is primarily intended for acoustic analysis of speech, but it has some additional functions such as speech synthesis and some constraint-based grammar learners. It can even run some basic perceptual experiments.
  • The program is very powerful and has many features, with new ones being added all the time. There are only a few features that a beginning phonetician would need; this tutorial covers them.

Installing Praat

  • Go to http://www.fon.hum.uva.nl/praat/ and follow the instructions for your operating system.
  • Mac users–drag the Praat.app file into your Applications folder. You may then add a link to the program onto your dock so you can enjoy looking at this icon every day. [EDIT 2020/2021: it is with great sadness that I learned that Praat authors finally changed the icon. It still has a mouth and an ear, though. I am keeping this here for historical reasons. It’s too important.]

Praat

  • Not enough space on your disk? This is an issue that Chrome OS users sometimes report. (Chrome OS stores everything in the cloud so the machines often have very little physical storage.)
    • Try to free up space on your machine. I would start with your browser’s data, which can be huge.
    • Chrome OS runs Praat inside a Linux installation, which you might already have. If not, see the instructions here for how to do it.
    • My Linux installation of Praat is 25MB, plus another 25 for the no-GUI version (my installation is on Linux Mint, not inside Chrome OS, so your mileage might vary).

Praat basics

The two windows

  • When you open Praat, two windows appear: the Objects window and the Picture window. You won’t need the Picture window most of the time, so close it. We’ll come back to it at the end of this tutorial.
  • The Objects window starts out empty, but once you open sound files and manipulate them, it will contain sounds, spectrograms, text grids and any other objects that you work with:
The Praat object window on a Mac.

The Praat object window on a Mac.

  • Important: the objects in the Object window are temporary and only exist in Praat’s working memory. If you change the content of an audio file using Praat, it won’t automatically save the changes. If you try quitting without saving the objects, Praat will prompt you to do so.

Opening, playing, recording, and editing audio files in Praat

Opening an existing sound file

  • Open Praat, click on “Open”, then “Read from file”. You will see a “Sound” object appear in the window, which you can then “View and Edit”.
  • In Mac OS, you can also drag your audio file or files onto the Praat icon. All of the files will then appear as sound objects in the list at once. See if your OS supports drag-and-drop opening of files.
  • Depending on the length of the recording, you will see either the waveform with an empty window below it or a waveform above the spectrogram.

Converting stereo to mono

  • If you are seeing two waveforms, your file is in stereo (was recorded with two microphones):
stereo_waveform

The two lines of black squiggles labeled “Channel 1” and “Channel 2” are your two stereo channels.

mono_waveform

Here, we extracted just one channel (the top one, recorded with the “left” microphone). Now we have a mono sound.

  • For speech analysis, you do not need stereo, since the vast majority of humans have only one mouth.
  • To get a mono file, you can extract one of the audio channels, like this:
  1. Return to the Objects window.
  2. Select the stereo Sound object.
  3. Click on “Convert”.
  4. Select “Extract one channel”. Unless the two channels are really different from each other, you can just accept the default, “1/left” channel.
  5. The new object will have the same name as the old but with “_ch1” appended at the end. Don’t forget to save it if you want to use it again.

Recording an audio file right into Praat

  • You can record right into Praat, as long as your computer has a built-in microphone. Most likely the recording will not be of awesome quality, but it’s fine for practicing with the program.
  • To record a sound, click on “New>Record Mono Sound”, and hit “Record” in the window that opens. You can accept all the defaults in that window.
  • One tip about recording: if you are using your laptop, you might not know exactly where the microphone is on it. I have no idea where the mic is on my laptop, actually. I just leaned in and talked close to the laptop. Here is the resulting recording of me saying a sentence in Russian, [napʲisənə lʲdotʲexnʲikə pʲatʲ ras] “The word ‘ice technology’ is written five times.”
ljdotexnika_me

A waveform and spectrogram of a sentence I recorded straight into my MacBook Air using Praat.

Recording: a note about clipping

  • When you record audio for speech analysis, you want the signal to be as loud as possible without exceeding the range of your microphone’s sensitivity.
  • Look at the black number in the upper left-hand corner of the screen, next to the waveform. Your recording should get as close to 1 as possible, but the waveform should not protrude above it. If the amplitude of the recording exceeds the range of the microphone, you get clipping.
  • A clipped recording is missing parts of the signal, and it sounds awful. Avoid.
  • Here is what clipping looks and sounds like. I had to pretty much yell at my laptop to get this to happen, so you’ve been warned. Your Praat recording widget has a meter display that stays green while you’re in good range and turns red when you are in the clipping range.
The last "clipping" is clipped. See how the waveform extends outside the waveform window?

The last “clipping” is clipped. See how the waveform extends outside the waveform window?

Playing audio

  • Once you have a Sound object, you could just hit “Play”. Usually, we want to play only portions of a file, sometimes repeatedly as we try to transcribe or determine the boundaries of a segment.
  • To play portions of a file, click on “View & Edit”, and make a selection with your mouse.
  • The playback options are in the “View” menu. Yep. I actually had to look for this just now because I usually play back the selection using the Tab key. Tab will also stop playback. Shift+Tab plays the visible window.
  • For Mac users: I’ve used a Mac for over a decade now but I still cannot keep track of the little symbols that apps use for keys. Here is a reference.

Editing a file

  • There are many things you can do to edit a file. Perhaps the most basic function, and one that you might find useful long after this class ends, is to cut out parts of a file.
  • First, open the Sound object of your file in the View & Edit window.
  • Make a selection you want to keep, using the mouse.
  • If you want to make a really neat cut, you can “Move start of selection to nearest zero crossing”–this is an option at the bottom of the “Select” menu. Then do the same for the end of the selection. What this will do is adjust the selection so that it starts and ends with a silence (zero amplitude).
  • Then click on “File”, and you have several options here.
    • You can put the selected sound into its own sound object, if you want to keep doing things to it (“Extract selected sound”, either preserving the time markings from the original file or resetting them to zero seconds).
    • You can also save the file to disk. There is a range of options, but a .WAV extension is the basic one.
  • The options above do not alter the original file or the Sound object in Praat’s memory.
  • If you want to modify the Sound object or the file, you can cut a portion of it out–useful if you have a long period of silence, or if you want to make someone say “got” instead of “Scott” or whatever. This is done via “Edit>Cut”.
  • Once you cut a portion out, it is placed on your clipboard (computer’s working memory); if you then save the Sound object to the original file again, the file will be permanently altered. If you do not want that, save it under a new name instead.
  • You’ll see other options in the menus, which are more or less self-explanatory. Feel free to play around with them, and remember that nothing is permanent until you save to disk.

Viewing spectrograms, pitch tracks, formants

  • Praat can only display spectrograms for relatively small chunks of audio, so if you want to see a spectrogram for a word, zoom in on it.
  • You can select a part of the recording with the mouse, and then use the View menu to zoom to that selection. The View menu is fairly self-explanatory.
  • There are keyboard shortcut hints in the View menu and many other places in Praat! Use them. I use Cmd+N to view the selections on Mac OS.
  • Here is a waveform and a spectrogram of a female Russian speaker (not me) saying [napʲisənə lʲdotʲexnʲikə pʲatʲ ras] “The word “ice technology” is written five times.” This sentence is a bit over 2 seconds long.
ljdotexnika_spectrogram

A waveform and a spectrogram of a 2-second Russian sentence.

Making a spectrogram look good

  • If you are working with a fresh install of Praat, your spectrograms most likely will look a lot more gray than the ones you see above. This is because the dynamic range is set very high in Praat by default–at 70 db. You want something like 30-50 for a recording that has some background noise.
  • The obligatory metaphor: Dynamic range refers to how low the cut-off is for the volume of frequencies that the spectrogram visualizes. The lower the number, the less you see. Think of it as taking pond water out of a bucket. The deeper you dip, the more muck you’ll scoop up. If your pond (=recording) is very clean, then you can dip pretty low (i.e., have a high number dynamic range). If your pond is mucky and dirty, then you better skim from the top (i.e., have a low number in your dynamic range).
  • Of course, just because you are skimming from the top doesn’t mean you have clean water. Here is what the laptop audio I recorded looks like with the defaults. You can clearly see two bands of air conditioner noise, the lower of which is around 2400 Hz. This kind of noise really interferes with acoustic analysis of speech:
The same recording of me saying that "ice technology" sentence, with a default dynamic range of 70 db. The two bands of noise are from the air conditioner in the background.

The same recording of me saying that “ice technology” sentence, with a default dynamic range of 70 db. The two bands of noise are from the air conditioner in the background.

  • To set the dynamic range, click on “Spectrum>Spectrogram settings”. Change it in 5 db increments until it looks good.
  • You can also change how high the frequencies go in the spectrogram display. The default is 0-5000 Hz. You can expand it quite a bit–some fricatives have noise at frequencies above 12000 Hz.

Viewing pitch tracks, intensity, and formants

  • Pitch.
    • This is pretty simple. While you have the Sound object open, click on “Pitch>Show pitch”. You will see a curvy blue line appear in the spectrogram window.
    • In Pitch Settings, click on “drawing method” and select “speckles”. I think it looks better than Praat’s default, “automatic”.
  • Intensity.
    • Click on “Intensity>Show intensity”. A yellow line will appear in the spectrogram window.
  • Formants.
    • Praat can also show you formants, and you can probably figure out the procedure for those on your own.
    • There is one thing you will have to change in the Formant settings depending on whether you are looking at a male or female voice: the maximum formant should be set for 5500 Hz for female speakers, and 5000 Hz for male ones.
    • These formant dots are estimated by Praat; you cannot always trust them.
  • Pulses.
    • This method visualizes glottal pulses that show up in voicing. If you turn “view pulses” on, you’ll see vertical blue lines wherever Praat thinks the glottal pulses occur.
  • Here is the Russian word [bʲitonəmʲiʂalkə] ‘concrete mixer’ with the pitch track, intensity, formants, and pulses turned on. You would rarely need to see all of these things at once, this is just for demonstration.
betonomeshalka

Pitch track: blue line, intensity: yellow line/green numbers, formants: red dots, glottal pulses: blue vertical lines in the waveform window.

Annotating an audio file with TextGrids

  • A TextGrid object allows you to mark certain periods or time points in a sound file.
  • You can have several tiers in a TextGrid: one to mark word boundaries, another to mark consonants, vowels, whatever you want.
  • You can type into the TextGrid using IPA fonts. See this page for more information on how to set up your computer so that you can do this painlessly and quickly.
  • Praat distinguishes between “point tiers” and interval tiers.
  • To create a TextGrid, start from the Objects window. Select your sound object and click on the “Annotate” button to the right.
  • You’ll see this window. Why the program suggests “Mary John bell” as the default tier names is a mystery to me.
Default TextGrid dialog

Default TextGrid dialog

  • You can either name all your tiers at once, as shown here, or name the first one and add more later.
  • I named my three tiers “word, segments, vowels”–you see them in the screenshot below.
  • Now comes one of the Praat gotchas: “View & edit with sound” is highlighted, and you would think that this would allow you to view your sound file and edit the TextGrid at the same time, but no. Clicking on that button just tells you that in order to do what you want to do, you have to select both the sound and the TextGrid in the objects window and click on the “View & Edit” button.
  • You can select the TextGrid and Sound objects with the mouse or with your keyboard keys. On a Mac, Shift + arrow (up, down) will let you select two adjacent objects in the window.
  • If you have more than one object in the list, make sure you select the TextGrid that goes with your sound file!
  • Once you are in TextGrid edit mode, you can add text on tiers, copy interval boundaries from one tier to another, and navigate between tiers and between intervals using either the mouse or just your keyboard–make sure to poke around the “Select”, “Interval”, and “Boundary” menus to see all the options.
textgrid

A TextGrid with three interval tiers, labeled in the International Phonetic Alphabet.

  • Make sure you save your TextGrid when you are done. By default, the TextGrid will be given the same name as your sound file, and the extension is .TextGrid.
  • Advanced note for the computationally curious: open a TextGrid in a text editor such as TextWrangler, and you’ll see that it’s just a Unicode text file with detailed information about the time points when a tier begins and ends, and its label and type. It looks like this:
File type = "ooTextFile"
Object class = "TextGrid"

xmin = 0 
xmax = 1.2121237048836804 
tiers? <exists> 
size = 3 
item []: 
    item [1]:
        class = "IntervalTier" 
        name = "word" 
        xmin = 0 
        xmax = 1.2121237048836804 
        intervals: size = 2 
        intervals [1]:
            xmin = 0 
            xmax = 1.1468403366828597 
            text = "bʲitonəmʲiʂalkə" 
        intervals [2]:
            xmin = 1.1468403366828597 
            xmax = 1.2121237048836804 
            text = "" 
  • Can you guess what “xmin” and “xmax” refer to, and how you might collect information about interval duration automatically by script? More on that below.

That Picture window

  • Finally, we get to the mysterious Picture window. The point of the Picture window is to make professional, publication-quality images from your spectrograms, waveforms, and whatever other aspect of speech that you use Praat to visualize.
  • Whenever you see a “Draw” or “Paint” option associated with an object, it refers to the Picture window.
  • For example, open a sound file and click on the Spectrum menu–you’ll see “Paint visible spectrogram” as an option. The same “paint” option is available for intensity, pitch, formants, and other views.
  • To make a spectrogram picture with a pitch track overlaid on top, I “painted the visible spectrogram” and then “painted the visible pitch” while unchecking the “erase first” box. This superimposes the pitch track on top of the spectrogram picture.
  • Poke around the menus, check out the options, and see what “Garnish” does.
picture_window_editing

Screen shot of the picture window in action

betonomeshalka

A nice picture of the word [bʲitonəmʲiʂalkə], with a speckled pitch track superimposed in black.

Beyond basics

  • To get a sense of the full power of this program, you can just look at the various collections of Praat scripts that people have made available.
  • Praat uses its own scripting language, which is based on the commands in the program’s menus.
  • You can automate a lot of tasks:
    • Record a word list, cut it up into smaller files at silences automatically and label all the smaller files from a text file you specify.
    • Normalize the intensity of a bunch of different audio files, so they all sound approximately equally loud
    • If you have to label a lot of audio files, you can automate opening and TextGrid creation.
    • You can also automate the collection of durations, intensities/pitch at various time points, Praat-estimated formant values, and so on.
  • To get a sense of all the options, do a web search for “Praat scripts”. I really like Mietta Lennes’ page, but there are many others, such as this Google Sites archive.
  • There is also the actual Praat Help, which you can search.

Comments Off on Praat tutorial

September 3, 2016 · 14:53

Git configuration

Coming to GitHub from Dropbox, Google Docs, etc. can be a rough ride, since some aspects of the system are a bit counterintuitive. There are numerous git cheat sheets out there, so I recommend you look for them. I like these:

https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf

https://alvinalexander.com/git/git-cheat-sheet-git-reference-commands

The basic thing to keep in mind is that the system allows you a lot of control over what gets synced and when, and things aren’t called what you might expect them to be called. Also, a lot of things that you might expect to happen in a single step require multiple steps (e.g., there is no “sync” in the command line version; you have to commit, pull, and push separately).

Initial git setup

Once you have created a directory called “git”:

$ git init

Set up SSH and add an SSH key for the new machine:

On a Mac:

$ ssh-keygen -t rsa -b 4096 -C "email@host.com"

When prompted, agree to the location for saving the key:

/home/yourname/.ssh/id_rsa
OR
/Users/yourname/.ssh/id_rsa

Check ssh-agent and enter password when prompted:

$ eval "$(ssh-agent -s)"
$ ssh-add ~/.ssh/id_rsa

Copy the SSH key from terminal to the GitHub site. On Mac OS, do this:

$ pbcopy < ~/.ssh/id_rsa.pub

On Linux, they have this xclip thing, but the SSH key is just a block of meaningless text so you can use your preferred text editor to copy and paste.

$ xclip -sel clip < ~/.ssh/id_rsa.pub

Once this is done, test that SSH is working:

 $ ssh -T git@github.com

Cloning a repo

Once you have git set up on your machine, navigate to the git directory and copy (clone) your repositories into it one by one. The repos have to exist, and the easiest way to make them is through the GitHub website.

$ pwd
~/git
$ git clone git@github.com:username/reponame.git

Some useful global settings

The global settings are kept in the git config file.

$ vim ~/.gitconfig

Add the following to the git config file


 $ git config --global user.name "Your Name"
 $ git config --global user.email email@host.com
 $ git config --global core.editor vim

This sets up Text Wrangler as your diff tool, so you can compare versions and decide which to keep:


[diff]     
     tool = "twdiff" 
[difftool]     
     prompt = false 
[difftool "twdiff"]     
     cmd = /usr/local/bin/twdiff --wait --resume "$LOCAL" "$REMOTE" 
[merge]     
     tool = "twdiff" 
[mergetool]     
     prompt = false 
[mergetool "twdiff"]     
     cmd = /usr/local/bin/twdiff --wait --resume "$LOCAL" "$REMOTE"

For Linux, a good GUI diff tool is meld:

[core]
    editor = vim
[diff]
    tool = "meld"
[difftool]
    prompt = false
[merge]
    tool = "meld"
[mergetool]
    prompt = false

In addition to this, each repository should have a .gitignore file. You can look around for other people’s .gitignore files, but here’s an example of the contents of some of mine:

*.swp
*.pyc
*.swo
.DS_Store
ethumbs.db
*.lyx~
*.py~
temp/*
code/stuff_i_dont_want_people_to_see

Standard commands

Find out what’s new, if anything:

$ git status

^ All this does is compare the current state of the stuff inside your repository to the previously synced version; it does not actually connect to the internet. For that, you’d want to do a dry run (see below).

If checking git status turns up an untracked file or several, that means you haven’t committed certain changes, so do this:

$ git add /path/toyour/file.py
$ git commit -m 'removed a TypeError bug from file.py'

You can commit them individually or do the following. If you take this step, make sure your .gitignore file has at least some stuff in it–otherwise all sorts of garbage will turn up in the master version of your repository.

$ git add --all

If you run git status again, you will see that the path to file.py (or all the files, if you did –all) appears as “new file”, as “changes to be committed”. Once you’ve committed, git status will tell you that there is nothing to commit. This does not mean your stuff is online yet, because that requires a separate step:

$ git pull origin master

^ This gets stuff from repo into your local git copy. Do this first before attempting to push to it, in case new changes have been introduced by others.

$ git push origin master

^ This puts stuff into the official master copy of the repository online.

$ git rm path/filename

^ This removes the file from the list of files that git will track. It does not remove the file from your repository; if you want it there but untracked, you might want to put the partial path to it in your .gitignore file.

$ git add path/filename

^ If a new file has been added or a file has been modified, this will add it to the git status record so it will be included in future sync attempts.

$ git mv path/filename

^ This is the way to move things around to organize them. If files are moved using the regular file manager methods instead, you can end up with duplicate files on unsynced machines. See “counterintuitve notes” below.

$ git diff 

^ This is only relevant if you are collaborating with people on code; they might have introduced a change that conflicts with yours. You have to reconcile the differences using a merge tool (see the git config stuff earlier). The other time this can arise is if you have multiple machines and didn’t pull from the repository before adding changes; the conflicts will show up as if two people made changes. If you have used Dropbox or similar in the past, this should look familiar.

Branches: creation and deletion

Add a new branch called “test”:

$ git branch test

Switching between branches:

$ git checkout test
$ git checkout master

Syncing the new branch to the remote server:

$ git push -u origin test

Deleting a branch locally:

$ git branch -d test

And on the git server:

$ git push origin --delete test

Undoing a push

$ git revert HEAD

This undoes the last commit.

Further counterintuitive notes

GitHub tolerates directory structures but does not directly support them. That means it will respect paths when syncing repository content but it doesn’t have a native way to create folders or move files up or down. If you want things to appear in folders, do it through your OS, then do the “git add” or “git rm” steps as applicable above.

“Commit” and “push” are separate steps (unlike the little “sync” button in the GitHub Desktop thing). Commit just records changes in the local config file and in the versioning system; this is why it requires a comment. “Push” actually puts things in the repo, via SSH in my case. Ditto for “pull”.

To see what the differences are between the server repo and your local repo, do a dry run:

git fetch && git diff --stat origin/master

If GitHub is refusing to let you commit or push even though the file differences have been reconciled, git add the file. That should fix it.

 

Comments Off on Git configuration

Filed under git

Running R on multiple cores, Mac OS

If you do something computationally intensive, such as fitting a hierarchical/mixed effects model with random slopes in the lme4 package, you might find that R takes hours and sometimes even days just to tell you that it didn’t converge. In my struggles with R, I figured out this way to run several models at a time on several CPU cores. Here is how I did it.

When invoked from R.app, R runs on just one CPU at a time in Mac OS. But if you run R from the command line, you can assign different R processes to different cores:

  1. Open Terminal. (Macintosh HD>Applications>Utilities>Terminal.app).
  2. Start screen by typing screen at the command prompt.
  3. Start R by typing R at the command prompt on the screen emulated terminal. You might have to hit space to get to the prompt itself–check the screen manual for more.
  4. Paste in your R commands from wherever you keep them. Alternatively, run an R script using the source() command. Here’s a small example:
  5. setwd("/blah/blah/blah/place_you_want_your_output/")
    exp = read.csv("your_dataframe.csv") #Make sure it's in the working directory
    library(lme4)
    Sys.time() #this tells you when R started running the model
    model1<-lmer(blah blah); Sys.time(); save(model1, file = "model1.Rda") #this is your huge fully crossed model.

  6. Since R can take a while to fit an lmer model (I've had models run for 91 hours before failing to converge!), you might want to let R run in the background while you are doing other things. Running R in screen allows you to do that. Disconnect from the screen while R is running by hitting Ctrl+A and then Ctrl+D.
  7. You can reconnect to the R screen by entering screen -R at the command line.

 

 

(These instructions were current as of R 2.14 on Mac OS 10.6.8, and my iMac has a 3.06 GHz Intel Core i3 processor and 4 GB of 1333 MHz of RAM. If you know that something has changed, please tell me!)

Once your .Rda file is saved, you can open it in R to inspect the model using summary(model1). If you get a message about non-convergence, use the model you did get to decide which random slopes to remove. Here is how to decide:

 


sort(sapply(ranef(model1)$subject, sd))
sort(sapply(ranef(model1)$word, sd))

 

Take the random effect term with smallest standard deviation out of the model and try running the model again.

Since there is a chance that your next model won't converge, either, you can run multiple instances of R on the same Mac by repeating the steps in 1-6 for different models. When you run the screen -R command, you'll see that you have multiple screens running; connect to each of them separately by using the screen ID number you see.

You can of course connect to your Mac remotely using SSH and connect to the R-running screens to check on whether the models are still running, or use top to check how much CPU % your various instances of R are using.

Comments Off on Running R on multiple cores, Mac OS

Filed under R, tutorials

Switching to LyX for Linguists

Introduction

This page explains how users of OpenOffice, Microsoft Office and other word processors can migrate to LyX, a Graphical User Interface for LaTeX.

I rarely use anything other than LyX these days for work, but you should be warned that switching to LyX/LaTeX is not a dabble, it’s a commitment. This page will get you started, but to really learn and understand how it all works, you will definitely have to poke around the manuals and have to decipher unclear instructions on your own. This is the price you pay for free software.

Advantages of LyX

  • Free
  • Stable
  • Fast
  • Compact: takes up very little room on your computer (11 times smaller than MS Office) and produces small files
  • Produces beautifully typeset PDF files that are readable on any machine
  • Makes typesetting equations and mathematical formulas easy
  • Excellent, powerful bibliography support
  • Easier to learn than LaTeX, since it is almost a WYSIWYG environment (i.e., what you see on the screen while you are editing the document looks almost like the final output)
  • Can export to HTML and to LaTeX
  • Better suited to the needs of linguists than OpenOffice. LyX even includes a special Linguistics module.

Disadvantages of LyX

  • Steeper learning curve than for word processors
  • Some things that are very easy in MSWord are harder in LyX, e.g., trees and some features of tables (beats OpenOffice, though!)
  • This is an open-source program, so occasional bugs are introduced after updates, even as other bugs are fixed
  • Many of the things linguists need to do require special packages that you have to download; the packages themselves require learning
  • Many of the more advanced typographic tasks require using the LaTeX mark-up language, so you do not know what your document will look like until you typeset it.
  • You have to pay very careful attention to the syntax of LaTeX code. Just as in HTML, misplaced spaces, brackets, and slashes can break your file
  • If you collaborate with MS Word users, you have to get MS Word or Open Office; LyX documents do not easily convert to those formats
  • It only does the one thing–make documents. For your spreadsheet and slide presentations, you have to keep Open Office around

Downloading and setting up LyX

  1. Since LyX is basically a sophisticated front end for LaTeX, the first step is to get a working LaTeX installation.
  2. Mac: Install MacTeX. MacTeX is a large download because it includes several programs. But, it puts everything on your computer where it is supposed to go, including BibDesk and a spellchecker program (which I usually delete after installing).
  3. Windows: get MikTeX.
  4. Linux: you might already have both LaTeX and LyX on your system; it ships with some distributions. If not, apt-get install lyx should do it (it also installs the prerequisite, Tex Live, which uses up a ton of room and takes some time to download).
  5. Download LyX here. To check whether it works, open one of the Help manuals that comes with the program and make it into a PDF file. Here’s how:
  6. Open the LyX program, and go to Help>Tutorial.
  7. While the Tutorial is open, go to View>PDF(ps2pdf). If everything is installed correctly, you should see a PDF file of the Tutorial shortly. Otherwise, you’ll get a (possibly very) cryptic error message, and then God help you.
  8. Get a bibliography program. If you are a Mac user, you should have gotten BibDesk as part of MacTeX. Alternatively, get JabRef, which runs on any platform. JabRef is a freely available Java-based program that is similar to Endnote. Once you set up this program, you will be able to edit your bibliography database and search for references. If I were you, I would borrow someone else’s BiBTeX file. Of course, if you’re the strong silent type, you can also make your own from scratch. Note: The most recent distribution of LaTeX that I have came with a spellchecker program, Excalibur. LyX uses aspell and ispell, which I think are older LaTeX spellcheckers. I get annoyed with spellcheckers, but if you like them, perhaps you can figure out how to use them and tell me whether they are any good.
  9. The next step is to create and populate a texmf directory, which is where you keep extra packages (extensions not normally included in a TeX distribution). You’ll need them to do special formatting, like dashed lines in tables and so on.
    1. Mac: Re-create the following structure on your machine. You can look inside my texmf directory for reference.
      Macintosh HD/Users/YourUserName/Library/texmf/bibtex/bib/... (your bibliography files, with the extension .bib, go here)
      Macintosh HD/Users/YourUserName/Library/texmf/bibtex/bst/... (your custom bibliography formatting styles, with the extension .bst, go here)
      Macintosh HD/Users/YourUserName/Library/texmf/tex/latex/... (your latex packages go inside this directory. They can be inside other folders)
      Shortcut: you can simply take my texmf file and unzip it into your Library folder. If you do not see a Library folder, it is probably hidden, so you need to modify your OS view settings for these folders (find out how to do this for your version of Mac OS). Reconfigure LyX afterwards (LyX>Reconfigure), and it should find all the packages you have installed on your machine. You can verify that it did so correctly by going to the Tools>TeX Information menu of LyX and looking at the paths of installed .bst and .sty files. If new things aren’t showing up, hit “Rescan”. You can get additional packages from CTAN. Check CTAN for package manuals, since NONE of them are self-explanatory.
    2. Linux: As for Mac, re-create the texmf/tex/latex/etc. tree inside your user directory. Where to put it: you can get away with ~/texmf, but also see here for more complicated setups: http://math.arizona.edu/support/tex/accountpackages.html. As for Mac above, Reconfigure LyX (LyX>Tools>Reconfigure).
    3. Windows: It appears that there is no standard location for the texmf folder on this OS. You can put it wherever you want, but you will need to go through the extra step of registering it with MikTeX. Moreover, apparently, nothing happens automatically on a Windows LaTeX installation, so you have to update every time you add a package. Here are the instructions (see here for the full story):
      1. Run the MiKTeX “Settings” application (from the Start menu) and go to the “Roots” tab. That lists the directories on the search path MiKTeX uses. Add the location of your texmf folder to that tab (Add… button) and move it up to the top of the search chain.
      2. Whenever you add something to your local texmf directory, they should run the Settings application, and on the General tab click “Refresh FNDB” (which runs texhash to update the LaTeX file databases).

The packages

A linguist will probably need at least the following packages. You can download from CTAN, or copy my texmf directory:

  1. tipa: for phonetic fonts. Even though LyX can handle Unicode, on occasion, you still need to use the native IPA input method.
  2. arydshln: for dashed lines in tables. LyX can do solid lines, double lines, and no lines, but for dashed lines, you need a special package.
  3. colortbl: for shading cells in tables, if you’re gonna bother. I don’t recommend it for OT use, but it might come in handy for shading out holidays in syllabi or something.
  4. covington: for sequentially numbered examples and aligned glosses. There are alternatives, such as gb4e and such. Covington is implemented in LyX.
  5. bbding: For exotic symbols such as the pointy hand with cuff. You might want to download the LaTeX symbols manual while you’re at it.
  6. qtree: Trees. Others I use are xyling and forest.

Learning how to use LyX

Before you do anything else, you should take the LyX Tutorial, which takes about 30 minutes. The Tutorial is in the Help menu of LyX. If you already know how to use paragraph styles in Microsoft Word, this should not take very long and it won’t be that new to you, but you have to get used to the way LyX is set up. Then, read and try to typeset the Linguistics manual (LyX>Help>Specific Manuals>Linguistics). The next step is to go to LinguistLyX and practice with the formatting tricks discussed there. Make sure to try out the new Linguistics Module. There is a LyX help file associated with it, which takes you through the steps of special linguistics formatting.

Please read the manuals. Please use a search engine. It’s the only way. Your helpful local LaTeX users most likely have very customized needs and don’t know how to do everything you need. This is not the kind of program that is well suited to the idle personality.

Customization

You can customize LyX quite a bit to suit your work habits. I find the following indispensable.

  1. A customized key shortcut file (for Macs only; Windows and Linux users will have to figure this one out on their own): this allows you to use pre-defined key shortcuts and introduce new ones for starting numbered examples, switching between environments and so on.
  2. You can customize the preamble so that it always includes certain packages and other commands that you use often. Mine includes the following line:%\bibpunct{(}{)}{,}{a}{,}{,}The “%” symbol comments out the line so that it is ignored. The bibpunct command tells BibTeX how to format the punctuation in your bibliography (for example, the “year” will be surrounded by ( on the left and ) on the right, multiple publications from the same author of the same year will be annotated with letters such as “a”, references separated by commmas, and so on. Without it, the bibliography will not be formatted correctly. If you have the line but no bibliography, on the other hand, the file will not typeset correctly. So by default it’s commented out.
  3. LyX supports Unicode, so you can input IPA symbols directly in a Unicode IPA font such as SIL Doulos. For that, it really helps to have a keyboard layout. I like SIL’s old IPA-SIL layout, which they no longer distribute. The following zip file has a manual and the layout so you can install it on your Mac.

Some useful websites

Once you switch, you will need to look for help on your own. Pretty much everything you need to know about LyX and LaTeX is available online, though many still recommend Lamport’s published book guide to LaTeX for reference. Here are some LyX-related websites:

Comments Off on Switching to LyX for Linguists

Filed under lyx and latex, tutorials