UMBC High Performance Computing Facility

Working with documents and images on maya

Introduction

This page discusses how to work with documents and images on the maya cluster. Several software packages are available for viewing and editing these files. As a prerequisite for most of this discussion, we'll assume you have already set up an X display. Unless specified otherwise, all the packages here are open source, and are standard Linux tools.

Text editors

There are many ways to edit text files on maya. A few of them are

Vi - the standard text editor that's on just about every Linux system. Very powerful, but takes some getting used to. Try the command "vi" for the standard version, or "gvim" for the graphical version (which launches in an X window).
Emacs - besides Vi, Emacs is the other very popular text editor on Linux systems. It is also extremely powerful, and also has a learning curve. Try the command "emacs" - it will open a new window if you have an X display set up, or else start in your terminal window.
Nano - a less versatile editor than Vi or Emacs, but is very easy for beginners to use. To launch it, try the command "nano".
Nedit - an easier-to-use graphical editor. Try the command "nedit", which will launch the program in a new window.

Creating LaTeX documents

LaTeX is the standard tool for scientific publications. It should be possible to write documents entirely on maya using LaTeX. For users who prefer other document authoring software like Microsoft Word, you can of course do your writing on a separate machine.

Here's a minimal example of a LaTeX document

paper.tex

To compile it to a PDF, we can use the "pdflatex" command

[araim1@maya-usr1 ~]$ pdflatex paper.tex
This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
... lots of output ...
[araim1@maya-usr1 ~]$ ls
paper.aux  paper.log  paper.pdf  paper.tex
[araim1@maya-usr1 ~]$

To view the resulting PDF, we'll introduce a few more tools below.

Special poster and slide libraries prepared by Professor Rouben Rostamian are available on maya. To use them, first load the "umbclatex" module.

[araim1@maya-usr1 ~]$ module load umbclatex
[araim1@maya-usr1 ~]$

Creating slides for a talk

Beamer is probably the most popular LaTeX package for creating slides. It is already installed on maya, so let's go through a quick/minimal example. Start with the following document.

slides.tex

Compile it using pdflatex

[araim1@maya-usr1 ~]$ pdflatex slides.tex
...
Output written on slides.pdf (3 pages, 52682 bytes).
Transcript written on slides.log.
[araim1@maya-usr1 ~]$

Now you should have a PDF file of your talk

[araim1@maya-usr1 ~]$ ls
slides.aux  slides.nav  slides.pdf  slides.tex
slides.log  slides.out  slides.snm  slides.toc
[araim1@maya-usr1 ~]$

In the next section, we will describe some tools for viewing PDFs on maya. Your PDF should look like this.

Note: The UMBC slide themes designed by Dr. Rostamian from the UMBC Department of Math and Statistics are installed on maya.

Creating a poster

UMBCposter is a package written by Dr. Rostamian for easy preparation of posters in LaTeX. The package and its dependencies are installed on maya, and we will show how to compile the example poster on the cluster. First, download the tex file from the author's website.

[araim1@maya-usr1 ~]$ wget http://userpages.umbc.edu/~rostamia/umbcposter/sample.tex
...
2010-07-27 06:30:29 (200 MB/s) - `sample.tex' saved [2311/2311]

[araim1@maya-usr1 ~]$

Next compile the poster using pdflatex (the first time it's compiled, the pdflatex command must be run twice).

[araim1@maya-usr1 ~]$ pdflatex sample.tex
...
Output written on sample.pdf (1 page, 36351 bytes).
Transcript written on sample.log.

[araim1@maya-usr1 ~]$ pdflatex sample.tex
...
Output written on sample.pdf (1 page, 36351 bytes).
Transcript written on sample.log.
[araim1@maya-usr1 ~]$

Now there should be a PDF file with our poster

[araim1@maya-usr1 ~]$ ls
sample.aux  sample.log  sample.pdf  sample.tex
[araim1@maya-usr1 ~]$

See the next section for some ways to view your PDF on maya. Your PDF should look like this.

Viewing PDF files

PDF files on maya can be viewed directly (without requiring a file transfer to your local machine) if you have an X display set up. Browsing a PDF in this way is convenient, but generally much slower than it would be on your local machine. So for browsing long documents, it's recommended to transfer the file to your local machine and view it from there.

gv

gv is a tool for viewing PDF and Postscript files. It generally works quickly over a network connection.

[araim1@maya-usr1 ~]$ gv <pdf_file>

Example of opening our PDF with gv

acroread

acroread is Adobe's non-opensource Acrobat Reader. It can produce a very sharp display of your PDF, but is also generally slow to use over a network connection.

[araim1@maya-usr1 ~]$ acroread <pdf_file>

Example of opening our PDF with acroread

evince

Another open source PDF viewer available on maya is evince. It is generally quicker than acroread but slower than gv for remote browsing.

[araim1@maya-usr1 ~]$ evince <pdf_file>

Example of opening our PDF with evince

Manipulating image files

ImageMagick

ImageMagick is a sophisticated software package for working with image files. It provides APIs for several programming languages, and also some simple commands to use directly. To view an image file, simply type

[araim1@maya-usr1 ~]$ display <image_file>

where <image_file> can be in almost any graphical format. For more information about ImageMagick usage check out this page

GIMP

GIMP (GNU Image Manipulation Program) is an open application for manipulating images. The most basic usage is through the GUI, similar in spirit to Microsoft Paint or Adobe Photoshop. To launch GIMP, simply type

[araim1@maya-usr1 ~]$ gimp

[araim1@maya-usr1 ~]$ gimp <image_file>

Here's what it looks like when we open an image. Notice that along with the main image window, we get several other toolbars and menus that we can interact with.

Example of opening an image with GIMP

The first time you launch it, a profile will be created on disk for you. The program will walk you through this process. For more information about using GIMP try "man gimp" at the command line or see its webpage