EVALUATION MANUAL

6th Edition

GLOBE Claritas

Evaluation Manual

CONTENTS

PURPOSE OF THIS MANUAL ................................................................................................................1 WHO IS GNS SCIENCE AND WHAT DOES GLOBE CLARITAS DO?.................................................1 GLOBE CLARITAS LICENSING.............................................................................................................1 THE LEGAL BIT - DISCLAIMER AND COPYRIGHT NOTICE...............................................................2 HARDWARE, PLOTTER AND SOFTWARE REQUIREMENTS.............................................................2 INSTALLING GLOBE CLARITAS...........................................................................................................3 Prerequisite checking ...............................................................................................................................3 The Claritas install command ...................................................................................................................4 Local customisations ................................................................................................................................4 GETTING STARTED................................................................................................................................5 The GLOBE Claritas Launcher.................................................................................................................5 The Seishelp Application ..........................................................................................................................6 Quick overview of Claritas package contents...........................................................................................7 SUPPORT ................................................................................................................................................8 APPENDIX A - HOW TO DETERMINE YOUR ETHERNET ADDRESS ................................................9 APPENDIX B INSTALLING GLOBE CLARITAS BY HAND .............................................................10 Creating a directory to put Claritas in .....................................................................................................10 Unpacking GLOBE Claritas from the CD ...............................................................................................11 Setting up the users environment..........................................................................................................11 Installing the license key.........................................................................................................................11

GNS Science

Page i

GLOBE Claritas

Evaluation Manual

PURPOSE OF THIS MANUAL

This software manual is written for users evaluating the GLOBE Claritas seismic processing software, developed by GNS Science in New Zealand. It is not intended as a complete reference manual for the software since that manual is quite large, and is available on-line as part of the Claritas installation. Instead, this short document is intended to get the user started by explaining how to install the software, and how to access the help and the tutorial sessions.

WHO IS GNS SCIENCE AND WHAT DOES GLOBE CLARITAS DO?

The Institute of Geological and Nuclear Sciences (GNS Science) is a New Zealand Crown Research Institute - a government-owned earth science research institute which evolved from previous organisations such as the NZ Geological Survey and the Geophysics Division of the Department of Scientific & Industrial Research. GNS Science (http://www.gns.cri.nz) comprises about 250 research staff, with a broad range of disciplines including earthquake seismology, volcanology, geothermal and groundwater chemistry and isotope physics, including our own hydrocarbons group. We started writing the forerunner of GLOBE Claritas in 1984 to process our own land data, and gradually the software has grown into a 2D/3D interactive system which is in use worldwide. Although the initial development was done in a research environment, the current development directions for Claritas are mainly targeted towards industrial strength, efficiency and functionality. Some of the features that set Claritas apart from other processing packages include:

A friendly and powerful interface that is very easy to learn and use. An unusually high degree of flexibility (eg, geometry definition). The ease with which your own processing algorithms can be incorporated. A powerful (and optional) job control system database. Claritas can run under Linux on inexpensive hardware. Our clients tell us that our support service is excellent! Excellent output plot quality. A flexible licensing policy.

GLOBE CLARITAS LICENSING

An evaluation license to run Claritas usually runs for one month and is free. You are encouraged to contact GNS Science as often as you like during the evaluation, by e-mail to claritas.support@gns.cri.nz, or by phone, so we can get you up and running as quickly as possible. We require an Evaluation License Agreement to be signed before starting an evaluation - in signing this you are basically committing to protect the confidentiality of our software, and agreeing not to use it for commercial gain during the evaluation period.

GNS Science

Page 1

GLOBE Claritas

Evaluation Manual

The Claritas software is provided on a CD-ROM. To run it you will need a license key, which GNS Science provides by e-mail. To create this key we need to know the address of the ethernet card in your machine or possibly the local area network (LAN) ID (see Appendix A for details on obtaining the Ethernet card ID). If you wish to continue using Claritas you must sign a Software License Agreement and purchase a license from GNS Science. There are substantial discounts for research organisations if they are not making a profit from their seismic processing work. Multi-user licenses can be provided on a per-site basis with no restrictions on CPU type - this makes it particularly useful for heterogeneous Unix sites. License upgrades are not required when you upgrade your hardware. Leasing options are also available. As well as providing a quick response support line for your questions, the maintenance fee also covers new versions, which are currently being released at the rate of about two per year. The pace of development for GLOBE Claritas is quite high, and new features are being added daily. We also encourage users to tell us what enhancements they would like, and often these changes can be made in a matter of days (see the section on support below).

THE LEGAL BIT - DISCLAIMER AND COPYRIGHT NOTICE

GLOBE Claritas, and all its supporting documentation, is the proprietary product of the Institute of Geological & Nuclear Sciences Limited (GNS Science). GNS Science makes no claims about the suitability of this software for any purpose. The software is provided under license from GNS Science, as is, without express or implied warranty, including any warranty of fitness for a particular purpose and merchantability. Copyright Institute of Geological & Nuclear Sciences Limited, 1995-2009.

HARDWARE, PLOTTER AND SOFTWARE REQUIREMENTS

GLOBE Claritas runs under various kinds of Unix operating system. The various Unix distributors that are supported include Sun/Solaris, Compaq/Tru64 and Linux. Most of our Linux users use the RedHat distribution, but others (eg SuSe, Mandrake, Ubuntu) also appear to work fine. Details of which Linux releases are currently supported for GLOBE Claritas can be found on the Claritas web pages (www.globeclaritas.com -> Globe Claritas -> LINUX information). You can also use GLOBE Claritas in a Microsoft Windows Environment (2000 or XP); this is a separate version of the software that is bundled with Redhats Cygwin system. Cygwin creates a complete Linux operating system layer within a Windows environment, allowing you to run GLOBE Claritas. A single install shield guides you though the whole process. The hardware you decide to run Claritas on depends more on the size of your seismic datasets than on the software. Modern laptop or desktop PC type systems provide a good platform for general 2D usage; we would recommend a minimum of 2Gbytes of RAM, and you should consider a 64-bit CPU. We would recommend a minimum of 30Gbytes of disc space.

GNS Science

Page 2

GLOBE Claritas

Evaluation Manual

Multi-screen displays are supported by Claritas if the hardware supports them you can have up to four screens at a time. For larger datasets you would probably want to use 64-bit operating systems which will allow you to use more than 4 GB of RAM, and invariably, the more RAM you can add the better. Claritas can be run on Linux clusters, and there are specific modules to parellelise large portions of your processing flows. Additional cluster functionality is currently being developed. For seismic raster output, we strongly recommend the HP DesignJet range of plotters. We find them to be reliable, and the Claritas raster files are written out in the Hewlett-Packard raster format (HP-RTL) ready for direct spooling to colour or b/w plotters. Claritas includes filters to convert HP-RTL to some other common raster formats such as TIFF and Versatec. Claritas hardcopy plotting does NOT require any extra CGM file software. Very little extra software is required to run Claritas. You will need to have X-windows and a Fortran compiler. X-windows is provided with all Unix installations anyway, and most Linux distributions come complete with the GNU Fortran and C compilers, although you may need to request their installation when you install Linux. For Solaris, or Tru64 Claritas installations you will require the Sun or Compaq Fortran compilers to be installed. Claritas can be installed anywhere on your system, and Appendix B suggests one way to install the Claritas software. Users must have the GNS_HOME environment variable set to point to the directory in which Claritas has been installed, and $GNS_HOME/bin must be in the users PATH. One way to do this is described in Appendix B.

INSTALLING GLOBE CLARITAS

The Claritas installation is also described in the Install_instructions file on the distribution CD. Here, we describe only one method of installation with the emphasis on first installations. The easiest method of installing Claritas is to use the Install script found on the CD. Detailed notes on the various stages of the installation process can be found in Appendix B. The following steps are required: 1. Check you have Fortran and X windows installed, and a license key 2. Run the install script on the CD: bash <cd_mount_point>/Install.sh 3. Make any local customisations The Microsoft Windows version of GLOBE Claritas installs automatically.

PREREQUISITE CHECKING
To check that a valid Fortran compiler exists, type "f77" on its own. Different Unixes will give different responses, but if you get something like "f77:command not found" then either Fortran is not installed on your system, or it is but is not in your search-path. On Linux computers, look for g77 instead of f77 (command : "g77 -v") - if g77 is missing it should be on the Linux distribution CD set, or the distribution software repository.

GNS Science

Page 3

GLOBE Claritas

Evaluation Manual

This is not required for the Microsoft Windows version, as all components are bundled with the install package. If you dont already have a valid license key from GNS Science, send us the ethernet card ID by e-mail (to claritas.support@gns.cri.nz) so we can issue one (see Appendix A for details on how to determine the Ethernet card address). If you opt to start the launcher immediately after installation is completed, the license management utility will start; this will provide all of the information we need to generate your key, and allows you to enter your key once it has been sent to you.

THE CLARITAS INSTALL COMMAND

The Install script will be found on the CD-ROM, and has various modes of operation. The first step is to put the CD in the drive, mount it (this may require root permissions) and CD to the CD-ROM directory, for example:
mount /mnt/cdrom cd /mnt/cdrom

For new installations (e.g. evaluation licenses), please type:

bash Install.sh

For the rest of the process you just need to answer the questions on the screen. If you want a bit of help, type bash Install.sh -h or refer to the notes in Appendix B. If you get permission denied error messages when trying to run the Install script from CD, please ask your system manager to check that the cd-rom mount point in /etc/fstab has the exec flag set (please type man mount, for details). The Microsoft Windows version has an autorun facility enabled and the install will start automatically.

LOCAL CUSTOMISATIONS
These are usually optional - the files unpacked from the CD should be ready to run. However Solaris installations sometimes require a little extra work. See the section "Special requirements for Solaris users" in the installation instructions in: /mnt/cdrom/claritas/Install_instructions The other customisations that may be required are to the files in the $GNS_HOME/local directory - these changes are described in the README file in that directory, and cover topics such as plot labelling text, logo bitmaps for output plots and sample X-window defaults. It is usually OK to ignore these changes for the purposes of a software evaluation.

GNS Science

Page 4

GLOBE Claritas

Evaluation Manual

GETTING STARTED
Claritas is thoroughly documented, and browsing the help is very easy. This section shows you how to find that help, gives a brief overview of what the Claritas package contains.

THE GLOBE CLARITAS LAUNCHER

The GLOBE Claritas launcher gives access to all the GLOBE Claritas applications and utilities, grouped into broad classifications; to start the launcher simply type launcher at the prompt.

The GLOBE Claritas launcher in standard mode.

The launcher tabs (down the right side) allow you to select different the different classifications of application or utility; in some cases the same application may be under several classifications, but operating in different modes. If you would prefer a horizontal layout of the tabs, you can start the launcher in this mode using launcher h.

The GLOBE Claritas launcher in horizontal mode.

Using the launcher is entirely optional; all of the utilities and applications it is used to access can also be run directly from the UNIX prompt, simply by typing the command name once the claritas environment has been started. Using the launcher is strongly encouraged, however; it allows easy access to all of the tools and utilities and is fully integrated with the projectbased data management layer (DML). The launcher can work in two ways; you can either specify a working directory or select a project to work on, using the menus at the top of the launcher. You can change the working

GNS Science

Page 5

GLOBE Claritas

Evaluation Manual

directory or the project the launcher is accessing at any time; any application you open is labelled with the project it was started under and/or the local directory. One of the key category tabs to be aware of is the Help area; this allows access to the full on-line help utility, and, of you are connected to the internet, the on-line bug-reporting system. One of the key category tabs to be aware of is the Help area; this allows access to the full on-line help utility, and, of you are connected to the internet, the on-line bug-reporting system.

Options available on the GLOBE Claritas launcher under the help tab.

THE SEISHELP APPLICATION

Clicking on the Help button under the Help tab on the launcher will start the Seishelp utility. You can also type seishelp at the unix prompt.

The initial selection menu displayed by running the seishelp utility.

Seishelp gives access the full on-line help and manuals for GLOBE Claritas; while you can generally access the same information directly from all of t he applications and utilities, the search functionality can be particularly useful when trying to develop workflows. Items in the menu with a -> arrow give sub-menus, and clicking on a document name will open a text window to let you view the document and follow any links embedded within it. To remove a menu, click on the title bar at the top. Type "seishelp 16.1.1" to display the seishelp section of the manual.

GNS Science

Page 6

GLOBE Claritas

Evaluation Manual

The last item in the top-level seishelp menu is "Software manual" which gives you access to the latest version of the documentation. To view the help on individual process modules, choose the "processor modules" menu - you can then type in the name of the module you want, or select from a list of modules or module categories. The seishelp command can also be used to jump in to menus or documents, such as in the following examples:
seishelp agc seishelp chap3 seishelp xsje seishelp 3.2 seishelp -s AGC

(provides the AGC process module documentation) (to browse the chapter 3 of the manual) (to display the xsje help menu) (to display section 3.2 of the manual) (to choose from a list of articles containing the text string AGC)

The individual help for each application is available by clicking on the word "Help" at the topleft corner of the application windows. The individual help for e ach Claritas processor module can also be accessed from the job editor (xsje) by clicking on the Dictionary button. Most Claritas applications will also print something useful if you use the command with -h, for example "s qc -h" or "xsje -h". You can pipe the output from these commands to the Unix "more" command, eg "sqc -h | more".

QUICK OVERVIEW OF CLARITAS PACKAGE CONTENTS

There are four kinds of programme in GLOBE Claritas: A seismic job editor which is used to create and run processing flows. The process modules which perform the actual data processing. A suite of interactive applications. A collection of smaller miscellaneous utilities.

The Job editor (xsje) is the most frequently used part of the package. It lets you build up processing flows using the range of process modules available. xsje also gives access to the help for each of these modules and lets you run the job. An optional Job Control System can also be used for efficient multi-line processing. There are more than 250 process modules (such as NMO, AGC etc). You can get the description for each one via the "Dictionary" button in xsje, or via the sei shelp command (eg, "seishelp nmo"). These modules are used to build up a processing flow to perform the required data processing sequence. One module (XVIEW) is particularly important since it is the interactive seismic display module. The interactive applications include:
- seishelp - geometry - refstat
GNS Science

Interface to Claritas help pages For seismic geometry definition Refraction statics analysis (also refstat3d)
Page 7

GLOBE Claritas

Evaluation Manual

- sv - sqc - sqc b - cva - wavelet - Xrtl - muting - areal - isovels - viewmodel - viewshf

Seismic viewer and picker Seismic Quality Control (interactive display) For first-break picking Claritas velocity analysis package Wavelet processing and analysis X-window display of raster bitmaps Smoothing of generalised muting patterns Plots seismic attributes in an areal (map) sense Velocity model editor Refraction earth-model editor Static-shift display and manipulation

There are also three editors within Claritas: - xsje - xsde - xedt Seismic job editor Seismic data editor (spreadsheet) Text editor

Finally, the utilities tend to be smaller programmes with little or no interactive capability, for doing specific tasks such as converting raster file formats and preparing seismic survey data. You can see the list of available utilities by typing "seishelp utilities".

SUPPORT
We encourage you to ask question s during your evaluation of GLOBE Claritas. We pride ourselves on our level of support which, judging from user comments, would appear to be much better than is usually encountered. We are happy to answer any question about Claritas usage, however silly it might seem, although we do not generally provide advice on geophysical processing theory or technique. We are also happy to receive suggestions or requests for enhancements to Claritas, and often these changes can be made within a day or two, if possible. So please don't be afraid to ask! The best way to contact us is by e-mail to claritas.support@gns.cri.nz. Wellington is 12 hours ahead of GMT, so depending on where you are, you may get a response in a few minutes, or a few hours. If you are online, you can also con tact us using the Report Bug button on the launcher (under the Help tab) which will open our issue reporting webpage.

GNS Science

Page 8

GLOBE Claritas

Evaluation Manual

APPENDIX A - HOW TO DETERMINE YOUR ETHERNET ADDRESS

The ethernet address is a 12-character string, usually split into 6 pairs separated by hyphen or colon. For example: 03-DF-E0-1A-98-B1 or 03:DF:E0:1A:98:B1. There are various ways to find what this address is on your computer, and your system manager might already have the information. There is a failsafe method, which requires you to log on to the GNS Science ftp site and download a small Unix programme (called printlan) which prints out the Local Area Network ID and the ethernet card address to your screen. To get and run printlan :
% ftp ftp.gns.cri.nz ftp> (log on as anonymous, supply e-mail address as password) ftp> cd pub/claritas/ ftp> dir (to list available directories) ftp> cd Linux (or Solaris,AIX,DECOSF) ftp> binary (set binary transmission mode) ftp> get printlan ftp> quit % chmod +x printlan (make the file executable) %./printlan (run printlan)

If you have any problems please don't hesitate to let us know. Linux users can also log on to their systems type the Unix command "/sbin/ifconfig -a" - there will be a line similar to:
eth0 Link encap:Ethernet HWaddr 00:C0:F0:17:20:25

GNS Science

Page 9

GLOBE Claritas

Evaluation Manual

APPENDIX B INSTALLING GLOBE CLARITAS BY HAND

This section describes the various stages of the Claritas installation process. These tasks are normally accomplished using the Install script on the CD. There are four steps to the installation procedure: 1. Create a directory to unpack the Claritas distribution into 2. Unpack the relevant tar archive from the CD into the new directory 3. Make sure that GNS_HOME is set for all potential Claritas users, and that $GNS_HOME/bin in their search PATH 4. Obtain and install the software license key

CREATING A DIRECTORY TO PUT CLARITAS IN

Claritas can be installed anywhere on your system, and is referenced using the GNS_HOME environment variable which must be set to point to the directory where Claritas (or the current version of it) resides. If you wish to have multiple version available at the same time, you may wish to set up a symbolic link to point to the most recent version, for example:
% printenv GNS_HOME %ls l /opt/Claritas total 8 lrwxrwxrwx claritas drwxrwxr-x claritas drwxrwxr-x claritas

16 4096 4096

Apr 8 current -> V3.9.5 Feb 6 V3.9.0 Apr 7 V3.9.5

You may not need root privilege to create the Claritas directory, but we assume here that you do. We also assume that your Unix username is "fred" and that the version of Claritas you're about to install is V04.3.1:
su root cd /opt mkdir Claritas chown fred Claritas exit

(log on as super-user, and supply password)

(log-off as root; now back as user fred)

cd /opt/Claritas V4-3-1 mkdir V4-3-1 (This is the directory youll unpack into) ln -s V4-3-1 current (This makes a symbolic link called "current")

Note : If you install later versions of Claritas, you can then make a parallel directory (eg, /opt/Claritas/V4-4-2) and just change the "current" symbolic link to point to the new version. In this way you can upgrade versions without requiring users to change their GNS_HOME environment variables. If you only want to have one version of Claritas available, you can let the GNS_HOME variable point to a single directory, eg, /opt/Claritas. The Claritas binaries are stored in $GNS_HOME/bin, and this directory must be in the users search PATH variable (see below).

GNS Science

Page 10

GLOBE Claritas

Evaluation Manual

UNPACKING GLOBE CLARITAS FROM THE CD

Mount the CD - the mount point will vary between machines, but two common possibilities are /cdrom and /mnt/cdrom. Linux systems will often mount the CD automatically when you insert it in the drive. If you are unsure of the mount point you may be able to see the CD mount point listed in the filesystems file (/etc/fstab or /etc/filesystems depending on what kind of Unix you have). When the CD has been mounted correctly, you should be able to see four directories on it : claritas/ datafiles/ manuals/ and tutorials/ . In the examples below (which follow on from those above) we assume that the CD was mounted on /mnt/cdrom. Do a listing of the /mnt/cdrom/claritas directory and identify which of the *.tar files is the correct one for your system (use the Unix "more" command to view the file claritas/Install_instructions if you are unsure). For this example we choose the case of a RedHat9 installation:
cd /opt/Claritas/current/ tar xf /mnt/cdrom/claritas/Claritas_V040301_RedHat9.tar

SETTING UP THE USERS ENVIRONMENT

To run Claritas, you first need to set an environment variable (GNS_HOME) to point to the installation directory. For the example above, you would do this by:
setenv GNS_HOME /opt/Claritas/current export GNS_HOME=/opt/Claritas/current (csh/tcsh) (bash)

or

This should be done in your user configuration files for future logins. To set up the Claritas environment you would then issue the command:
source $GNS_HOME/claritas . $GNS_HOME/claritas.sh (csh/tcsh) (bash)

or

Amongst other tasks, these startup files ensure that the users search PATH includes $GNS_HOME/bin and . so that processing flow executables in the users current working directory can be accessed.

INSTALLING THE LICENSE KEY

If you dont already have a valid license key from GNS Science, send us the ethernet card ID by e-mail (to claritas.support@gns.cri.nz) so we can issue one (see Appendix A for details on how to determine the Ethernet card address). The license key comprises three lines of text which need to form the contents of the file $GNS_HOME/local/license.dat (after Claritas has been installed). The easiest way to do this is to save the e-mail to a file, transfer this file to the Unix machine with Claritas on, and then strip out all lines except the three license key lines.

GNS Science

Page 11

Principal Location
1 Fairway Drive Avalon PO Box 30368 Lower Hutt New Zealand T +64-4-570 1444

Other Locations
Dunedin Research Centre 764 Cumberland Street Private Bag 1930 Dunedin New Zealand T +64-3-477 4050 F +64-3-477 5232 Wairakei Research Centre 114 Karetoto Road Wairakei Private Bag 2000, Taupo New Zealand T +64-7-374 8211 F +64-7-374 8199 National Isotope Centre 30 Gracefield Road PO Box 31312 Lower Hutt New Zealand T +64-4-570 1444 F +64-4-570 4657

www.gns.cri.nz

F +64-4-570 4600