Project

General

Profile

esmePlot (Sparsely supported software)

esmePlot is a GUI written in R that allows the user to plot the output files created by ESMEMelkin.

The entire package can be downloaded using git

git clone http://cdcvs.fnal.gov/projects/esmemelkin-booster

This piece of software is to be used as is and is currently supported at the author's whim and fancy! So use at your own
risk! If you require a feature, you can ask but don't expect miracles. Bugs and requests can be sent to the author by using the
"New Issue" button after you log into RedMine or via email:

Requirements

The script esmePlot should run on any LINUX or MacOSX machine that has R installed.
(Windows is explicitly not supported by the author)

The instructions here are for MacOSX but should be generally applicable to LINUX.

R

Download and install R from here

Required R packages

esmePlot requires the following R packages to be installed.
In the R environment run the following commands

install.packages("gWidgetsRGtk2", dep = TRUE,type = "source" )
install.packages("stringr", dep=TRUE, type="source")

It is possible that your Mac does not have GTK+ already installed. In this case use MacPorts to install it.
In a terminal window type the following

sudo port install gtk2

Running

Copy esmePlot and esmePlotD to a directory that is in your path.
  • esmePlot is the non-debug version.
  • esmePlotD is the debug version that will print out debug messages.

The user must set up the following environment variable in his .bashrc file

export ESMEPLOT_DIR=<directory where the *.r files were installed>
with the <> contents replaced with the path of the directory where the R source files were installed.

To run the program, type the following in a terminal

esmePlot
or for the debug version
esmePlotD

User Guide

Here are some highlights of the program.

WARNING! esmePlot is easily tricked. So don't be surprised that if you try to be smarter than esmePlot
esmePlot will be successfully stupider than you!

Loading a file

The plotting of either an ESME generated data file with extension .txt or an ESME input file is supported.

If an ESME input file is chosen, it behooves the user to specify DIRNAME in one of the GRAPH commands. For example

O
 &GRAPH
  DIRNAME='./plots'
  TITL='START'
/END

What to plot

Pull down the options tab and choose one of the given options.

Once an option is chosen, the recorder type buttons can be used to display the plots that ESME had generated.

The user can choose the scales of the axis and the number of histograms to plot with these edit boxes and choices

Note: autoscale in R is, in the author's opinion, broken and so the user is advised to choose the scaling himself whenever possible.

For "bunch moments", "synopsis" and "RF status" a panel will popup for the user to choose what he wishes to plot

After choosing the parameters to plot, the user can advance the plots using the same play, previous and next controls shown above.

Pictures saved for this Wiki