Event-2D: Home Examples Install Documenation News & Pubs

Installing the Event-2D Software

Summary of the Installation

"... three sl files, two rc files, and an alias in a user startup script."

The Event-2D software consists of three ASCII files of S-Lang code which the user adds to their ISIS installation. The files are available here:

event2d.sl - v1.2.1, 2011-05-12
Event-2D library of routines for event-based 2D data and model analyses.
source3d.sl - v1.2.0, 2010-05-10
Source-3D library for defining 3D sources.
v3d.sl - v1.2.1, 2011-05-03
Volumetric 3D geometry creation library; see also the V3D web page.
Changes to these files (both made and planned) are summarized in: ChangeLog.txt.

These three files can be put in any convenient directory which is then added to the isis load path.

To help with startup things (like setting the load path), it is useful to have the files ~/.isisrc and ~/.hydrarc in the user's home directory. Examples of such files for a linux system are given here and can be copied and modified as desired/appropriate:

Finally, an alias is added to a user startup file (e.g., .aliases) to define the hydra command (see also comments in hydrarc.txt):
alias hydra 'isis $HOME/.hydrarc'
alias hydra="isis $HOME/.hydrarc"

Note that these are setup in such a way that typing isis at the system prompt will invoke isis without the Event-2D extras. Typing hydra will invoke isis and also include the additional Event-2D modules and software. The name "hydra" is a historic holdover from the Hydra project at MIT, and represents the ability of isis to be extended, e.g., "Beyond XSPEC".

The Event-2D s/w is then started (e.g., in a working directory) by typing "hydra" at the system prompt:

dd@socrates[49] cd /nfs/spectra/d1/Science/E0102/e2d_120510/

dd@socrates[50] hydra
 - - - - -
 Doing things in /nfs/cxc/h3/dd/.isisrc ... 
 - - - - -
 - - - - -
 Doing things in /nfs/cxc/h3/dd/.hydrarc ... 
         Event-2D web page: http://space.mit.edu/home/dd/Event2D/
 - - - - -

Welcome to ISIS Version 1.6.2-3

hydra> e2d_help;

    ... [useful reminder listing of the e2d commands] ...
hydra> quit;

If isis starts up and the hydra prompt appears as shown above then the s/w is probably installed and working fine. See the Examples and Documentation pages for next steps and more information.

Additional Installation Details

Getting Event-2D software to run can be as simple as described above, however there are two major categories of stumbling blocks that can arise:

Isis installation issues
The foundation for the Event-2D s/w is ISIS (and S-Lang) which must be installed along with HEASOFT and the XSPEC models library. See the ISIS Installation Guide for details and specific issues.
The following gives a simple 'smoke test' for the isis installation:
dd@socrates[50] isis
Welcome to ISIS Version 1.6.2-3

isis> plot([1,2,3],[2,4,8]);

isis> fit_fun("phabs(1)*vnei(1)");
       % define a wavelength grid from 8 keV to 20 A:
isis> (lo, hi) = linear_grid (Const_hc/8.0, 20.0, 2000);
isis> y = eval_fun (lo, hi);
isis> hplot(lo, hi, y, 4);  % 4 = blue

isis> quit;


hplot ouput

Additional modules that are needed
An isis installation can be augmented with additional S-Lang modules, including ones that Event-2D makes use of. The table (below) lists modules that are commonly included with isis, e.g., installed by the install-isis.sh script, as well as those that are used by Event-2D.

As the table below shows, there are two modules that are not generally provided with isis that Event-2D makes use of: imdisplay (w/gtk) and volview (w/volpack).

Used by
Installed by
cfitsio yes yes
gtk yes (imdisplay) No
gsl yes yes
histogram yes yes
imdisplay yes No
maplib - yes
pcre - yes
pgplot yes yes
png - yes
stats yes yes
volview Optional No
xpa - yes
xspec yes yes

Send comments to dd@space.mit.edu above last updated 5/10/2012