Eval Manual V5.1

7/22/2019 Eval Manual V5.1

1/14

EVALUATION MANUAL

6thEdition


2/14

GLOBE Claritas Evaluation Manual

GNS Science Page i

CONTENTS

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


3/14


GNS Science Page 1

PURPOSE OF THIS MANUAL

This software manual is written for users evaluating the GLOBEClaritasseismic processingsoftware, developed by GNS Science in New Zealand. It is not intended as a completereference manual for the software since that manual is quite large, and is available on-line as

part of theClaritas

installation. Instead, this short document is intended to get the userstarted by explaining how to install the software, and how to access the help and the tutorialsessions.

WHO IS GNS SCIENCE AND WHAT DOES GLOBECLARITAS DO?The Institute of Geological and Nuclear Sciences (GNS Science) is a New Zealand CrownResearch Institute - a government-owned earth science research institute which evolvedfrom previous organisations such as the NZ Geological Survey and the Geophysics Divisionof 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 earthquakeseismology, volcanology, geothermal and groundwater chemistry and isotope physics,including our own hydrocarbons group.

We started writing the forerunner of GLOBEClaritas in 1984 to process our own land data,and gradually the software has grown into a 2D/3D interactive system which is in use world-wide. Although the initial development was done in a research environment, the currentdevelopment directions for Claritasare mainly targeted towards industrial strength, efficiencyand functionality. Some of the features that set Claritas apart from other processingpackages 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.

GLOBECLARITASLICENSINGAn evaluation license to run Claritas usually runs for one month and is free. You areencouraged to contact GNS Science as often as you like during the evaluation, by e-mail [email protected], or by phone, so we can get you up and running as quickly aspossible. We require an Evaluation License Agreement to be signed before starting anevaluation - in signing this you are basically committing to protect the confidentiality of oursoftware, and agreeing not to use it for commercial gain during the evaluation period.


4/14


GNS Science Page 2

The Claritas software is provided on a CD-ROM. To run it you will need a license key, whichGNS Science provides by e-mail. To create this key we need to know the address of theethernet card in your machine or possibly the local area network (LAN) ID (see Appendix Afor details on obtaining the Ethernet card ID).

If you wish to continue usingClaritas

you must sign a Software License Agreement andpurchase a license from GNS Science. There are substantial discounts for researchorganisations if they are not making a profit from their seismic processing work. Multi-userlicenses can be provided on a per-site basis with no restrictions on CPU type - this makes itparticularly useful for heterogeneous Unix sites. License upgrades are not required whenyou upgrade your hardware. Leasing options are also available.

As well as providing a quick response support line for your questions, the maintenance feealso covers new versions, which are currently being released at the rate of about two peryear. The pace of development for GLOBEClaritasis quite high, and new features are beingadded 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 theInstitute of Geological & Nuclear Sciences Limited (GNS Science). GNS Science makes noclaims about the suitability of this software for any purpose. The software is provided underlicense from GNS Science, as is, without express or implied warranty, including any warrantyof 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 Unixdistributors that are supported include Sun/Solaris, Compaq/Tru64 and Linux. Most of ourLinux users use the RedHat distribution, but others (eg SuSe, Mandrake, Ubuntu) alsoappear to work fine. Details of which Linux releases are currently supported for GLOBEClaritascan be found on the Claritasweb pages (www.globeclaritas.com -> Globe Claritas ->

LINUX information).

You can also use GLOBE Claritasin a Microsoft Windows Environment (2000 or XP); this isa separate version of the software that is bundled with Redhats Cygwin system. Cygwincreates a complete Linux operating system layer within a Windows environment, allowingyou 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 seismicdatasets than on the software. Modern laptop or desktop PC type systems provide a goodplatform for general 2D usage; we would recommend a minimum of 2Gbytes of RAM, andyou should consider a 64-bit CPU. We would recommend a minimum of 30Gbytes of disc

space.


5/14


GNS Science Page 3

Multi-screen displays are supported by Claritas if the hardware supports them you canhave up to four screens at a time. For larger datasets you would probably want to use 64-bitoperating systems which will allow you to use more than 4 GB of RAM, and invariably, themore RAM you can add the better.

Claritas can be run on Linux clusters, and there are specific modules to parellelise largeportions of your processing flows. Additional cluster functionality is currently being

developed.

For seismic raster output, we strongly recommend the HP DesignJet range of plotters. Wefind them to be reliable, and the Claritas raster files are written out in the Hewlett-Packardraster format (HP-RTL) ready for direct spooling to colour or b/w plotters. Claritas includesfilters to convert HP-RTL to some other common raster formats such as TIFF and Versatec.Claritashardcopy 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 Linuxdistributions come complete with the GNU Fortran and C compilers, although you may needto request their installation when you install Linux. For Solaris, or Tru64 Claritas installationsyou 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 toinstall the Claritas software. Users must have the GNS_HOME environment variable set topoint to the directory in which Claritashas been installed, and $GNS_HOME/bin must be inthe users PATH. One way to do this is described in Appendix B.

INSTALLING GLOBECLARITASThe 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 Claritasis to use the Install script found on the CD. Detailednotes 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 /Install.sh

3. Make any local customisations

The Microsoft Windows version of GLOBE Claritasinstalls automatically.

PREREQUISITE CHECKING

To check that a valid Fortran compiler exists, type "f77" on its own. Different Unixes will givedifferent responses, but if you get something like "f77:command not found" then eitherFortran 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 onthe Linux distribution CD set, or the distribution software repository.


6/14


GNS Science Page 4

This is not required for the Microsoft Windows version, as all components are bundled withthe install package.

If you dont already have a valid license key from GNS Science, send us the ethernet card IDby e-mail (to [email protected]) 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 immediatelyafter installation is completed, the license management utility will start; this will provide all ofthe information we need to generate your key, and allows you to enter your key once it hasbeen sent to you.

THE CLARITASINSTALL COMMAND

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

mount /mnt/cdromcd /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 wanta 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 theexec flag set (please type man mount, for details).

The Microsoft Windows version has an autorun facility enabled and the install will startautomatically.

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 "Specialrequirements 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/localdirectory - these changes are described in the README file in that directory, and covertopics such as plot labelling text, logo bitmaps for output plots and sample X-windowdefaults. It is usually OK to ignore these changes for the purposes of a software evaluation.


7/14


GNS Science Page 5

GETTING STARTED

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

THE

GLOBEC

LARITASLAUNCHER

The GLOBE Claritas launcher gives access to all the GLOBE Claritas applications andutilities, grouped into broad classifications; to start the launcher simply type launcherat theprompt.

The GLOBE Claritaslauncher in standard mode.

The launcher tabs (down the right side) allow you to select different the differentclassifications of application or utility; in some cases the same application may be underseveral classifications, but operating in different modes.

If you would prefer a horizontal layout of the tabs, you can start the launcher in this modeusing launcher h.

The GLOBE Claritaslauncher in horizontal mode.

Using the launcher is entirely optional; all of the utilities and applications it is used to accesscan also be run directly from the UNIX prompt, simply by typing the command name once theclaritasenvironment 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 project-based data management layer (DML).

The launcher can work in two ways; you can either specify a working directory or select aproject to work on, using the menus at the top of the launcher. You can change the working


8/14


GNS Science Page 6

directory or the project the launcher is accessing at any time; any application you open islabelled with the project it was started under and/or the local directory.

One of the key category tabs to be aware of is the Helparea; this allows access to the fullon-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 Helparea; this allows access to the fullon-line help utility, and, of you are connected to the internet, the on-line bug-reportingsystem.

Options available on the GLOBE Claritaslauncher under the help tab.

THE SEISHELPAPPLICATION

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 cangenerally access the same information directly from all of t he applications and utilities, thesearch 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 willopen a text window to let you view the document and follow any links embedded within it. Toremove a menu, click on the title bar at the top.

Type "sei shel p 16. 1. 1" to display the seishelp section of the manual.


9/14


GNS Science Page 7

The last item in the top-level seishelp menu is "Software manual" which gives you access tothe 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 youwant, 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 thefollowing examples:

sei shel p agc (provides the AGC process module documentation)

sei shel p chap3 (to browse the chapter 3 of the manual)

sei shel p xsj e (to display the xsje help menu)

sei shel p 3. 2 (to display section 3.2 of the manual)

sei shel p - s AGC (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 top-left corner of the application windows.

The individual help for e ach Claritas processor module can also be accessed from the jobeditor (xsje) by clicking on the Dictionary button.

Most Claritasapplications will also print something useful if you use the command with -h, forexample "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 GLOBEClaritas:

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 upprocessing flows using the range of process modules available. xsje also gives access tothe help for each of these modules and lets you run the job. An optional Job Control Systemcan also be used for efficient multi-line processing.

There are more than 250 process modules (such as NMO, AGC etc). You can get thedescription for each one via the "Dictionary" button in xsje, or via the sei shelp command (eg,"sei shel p 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 isthe interactive seismic display module.

The interactive applications include:

- seishelp Interface to Claritashelp pages

- geometry For seismic geometry definition

- refstat Refraction statics analysis (also refstat3d)


10/14


GNS Science Page 8

- sv Seismic viewer and picker

- sqc Seismic Quality Control (interactive display)

- sqc b For first-break picking

- cva Claritas velocity analysis package

- wavelet Wavelet processing and analysis

- Xrtl X-window display of raster bitmaps

- muting Smoothing of generalised muting patterns

- areal Plots seismic attributes in an areal (map) sense

- isovels Velocity model editor

- viewmodel Refraction earth-model editor

- viewshf Static-shift display and manipulation

There are also three editors within Claritas:

- xsje Seismic job editor- xsde Seismic data editor (spreadsheet)

- xedt Text editor

Finally, the utilities tend to be smaller programmes with little or no interactive capability, fordoing 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 GLOBEClaritas. We prideourselves on our level of support which, judging from user comments, would appear to bemuch better than is usually encountered. We are happy to answer any question aboutClaritasusage, however silly it might seem, although we do not generally provide advice ongeophysical processing theory or technique. We are also happy to receive suggestions orrequests for enhancements to Claritas,and often these changes can be made within a day ortwo, if possible. So please don't be afraid to ask!

The best way to contact us is by e-mail to [email protected]. Wellington is 12 hoursahead of GMT, so depending on where you are, you may get a response in a few minutes, ora 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.


11/14


GNS Science Page 9

APPENDIX A - HOW TO DETERMINE YOUR ETHERNET ADDRESS

The ethernet address is a 12-character string, usually split into 6 pairs separated by hyphenor colon. For example: 03-DF-E0-1A-98-B1 or 03:DF:E0:1A:98:B1. There are various waysto 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 Scienceftp site and download a small Unix programme (called printlan) which prints out the LocalArea 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


12/14


GNS Science Page 10

APPENDIX B INSTALLING GLOBE CLARITAS BY HAND

This section describes the various stages of the Claritas installation process. These tasksare normally accomplished using the Install script on the CD. There are four steps to theinstallation 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

Claritascan be installed anywhere on your system, and is referenced using the GNS_HOMEenvironment 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:

% pr i nt env GNS_HOME

%l s l / opt / Cl ar i t as

t ot al 8

l r wxrwxrwx cl ar i t as 16 Apr 8 cur r ent - > V3. 9. 5

dr wxrwxr - x cl ar i t as 4096 Feb 6 V3. 9. 0

dr wxrwxr - x cl ar i t as 4096 Apr 7 V3. 9. 5

You may not need root privilege to create the Claritas directory, but we assume here that youdo. We also assume that your Unix username is "fred" and that the version of Claritasyou'reabout to install is V04.3.1:

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

cd /opt

mkdir Claritas

chown fred Claritas

exit (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_HOMEenvironment variables.

If you only want to have one version of Claritas available, you can let the GNS_HOMEvariable point to a single directory, eg, /opt/Claritas.

The Claritasbinaries are stored in $GNS_HOME/bin, and this directory must be in the userssearch PATH variable (see below).


13/14


GNS Science Page 11

UNPACKING GLOBECLARITASFROM THE CD

Mount the CD - the mount point will vary between machines, but two common possibilitiesare /cdrom and /mnt/cdrom. Linux systems will often mount the CD automatically when youinsert it in the drive. If you are unsure of the mount point you may be able to see the CDmount 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 fourdirectories on it : claritas/ datafiles/ manuals/ and tutorials/ .

In the examples below (which follow on from those above) we assume that the CD wasmounted on /mnt/cdrom.

Do a listing of the /mnt/cdrom/claritas directory and identify which of the *.tar files is thecorrect one for your system (use the Unix "more" command to view the fileclaritas/Install_instructions if you are unsure). For this example we choose the case of aRedHat9 installation:

cd /opt/Claritas/current/

tar xf /mnt/cdrom/claritas/Claritas_V040301_RedHat9.tar

SETTING UP THE USERSENVIRONMENT

To run Claritas, you first need to set an environment variable (GNS_HOME) to point to theinstallation directory. For the example above, you would do this by:

setenv GNS_HOME / opt / Cl ari t as/ cur r ent ( csh/tcsh)

or expor t GNS_HOME=/ opt / Cl ar i t as/ curr ent (bash)

This should be done in your user configuration files for future logins. To set up the Claritasenvironment you would then issue the command:

source $GNS_HOME/ cl ar i t as (csh/tcsh)

or . $GNS_HOME/ cl ar i t as. sh (bash)

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 workingdirectory can be accessed.

INSTALLING THE LICENSE KEY

If you dont already have a valid license key from GNS Science, send us the ethernet card IDby e-mail (to [email protected]) so we can issue one (see Appendix A for details onhow 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 Claritashas been installed). The easiest way to do thisis to save the e-mail to a file, transfer this file to the Unix machine with Claritason, and thenstrip out all lines except the three license key lines.


14/14

1 Fairway Drive

Avalon

PO Box 30368

Lower Hutt

New Zealand

T +64-4-570 1444

F +64-4-570 4600

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

Principal Location

www gns cri nz

Other Locations

Documents

Eval Manual V5.1