Adding External Library as OpenDtect Module

If we wanted to use external library(ies) for opendtect, we need to compile or get the compiled *.so and *.a files.

In my case, I use alglib, which should be compiled by user. Here's the makefile:

# Alglib sample makefile
# Tested on ubuntu 10.4 LTS
# Used for OpenDtect 4.0.1 ( http://opendtect.org )

CC=gcc
AR=ar
SRC=*.cpp
FLAGS=-Wall
OUT=/home/user/lib/libAlglib3
all:
 $(CC) -c -fPIC $(SRC) $(FLAGS)
 $(AR) -rcs $(OUT).a *.o
 $(CC) -shared -Wl,-soname,$(OUT).so.1 -o $(OUT).so *.o $(FLAGS)
 rm *.o
clean:
 rm *.o

Then we need to add our external library into ODWork environment.
The steps are:

1. Copy (or link) *.so file into $(ODWork)/bin/lux32/G/so


2. Copy (or link) *.a and * so into $(ODWork)/lib/lux32/G


3. Copy *.h files of our external library into $(ODWork)/include/Alglib


4. Copy *.cpp/*.cc files of our external library into $(ODWork)/src/Alglib


5. Edit make.od.ModDeps file in $(ODWork)/Pmake, adding LAlglib := -lAlglib3 and IAlglib := Alglib


6. Edit our plugin makefile, add Alglib to our MODDEPS variable

If there's any question please feel free to ask.

and thanks to Mas Toto for helping me with this.

Some extra note:

• Don't forget to use "ldd" to help you determine which lib needed by your plugin.

Linux C++ error (double free or corruption error)

if your program suddenly crashed during runtime and give you this kind of error:

*** glibc detected *** double free or corruption (fasttop): 0x08097c40 ***

use this command before executing your program:

export MALLOC_CHECK_=0
start_program &

Software development methodology

http://lists.opendtect.org/pipermail/developers/2006-February/000033.html

Making Our Own AttributeProvider in OpenDtect

As the default AttributeEngine's Provider class cannot altered as we wish. We need to do some re-routing of it if our plugin wanted to access some protected or read-only members from the original Provider.

Here's the diagram showing what I alter to allow my plugin to do things that the default Provider won't allow it to do:



Something like that...

OpenDtect AttributeEngine Process Flow

In making attribute computation program using OpenDtect we should follow the right flow so that our algorithm will be run nicely.

Process steps:

1. prepareForComputeData First to be called, and only once
2. getInputData
3. computeData a const (called n times; depends on our processor core number ? and if we set allowParallelComputation to yield true)
   
4. finalizeCalculation

Again. This is a quite simple problem, but it takes some times for me to figure it out (d'oh)
NOTE: getInputData(), computeData(), and finalizeCalculation() are called n times, where n = number of traces in a line. (Called inside doWork() method of Provider class)

Cleaning process for OpenDtect Objects

Previously: there is a pmake configuration to make OpenDtect Plugin...

If there's any change to the SRC.cc list then we should clean some objects created before, or those unused objects will make our plugin malfunctioned. (in other word: OpenDtect couldn't load the plugin)

Now, I just use this script (executed exactly on our plugin folder ? ):

#!/bin/bash
make source1.rmlib
make source2.rmlib

#and so on..

Simple... but without knowing this, making a plugin can give you (a pretty bad) headache!

oh c++...

Everyday Pmake Makefile for OpenDtect Plugin

SRC.cc := source1.cc source2.cc
PLUGIN := yes
PLUGINDEP := MySourcePlugin

OWNC++FLAGS := -DYOURFLAG1 -DYOURFLAG2

MODDEP := uiODMain
include make.od.Defaults
include make.Targets

OpenDtect (Preparing & Deploying Plugin)

Preparing:

1. Always use function below (XXX is your plugin name):

#include "plugins.h"

extern "C" int GetXXXPluginType()
{
    return PI_AUTO_INIT_EARLY;
}

extern "C" int GetXXXPluginInfo()
{
    static PluginInfo retpi ={
        "Plugin Name",
        "Author",
        "Version Number",
        "Description" };
    return &retpi;
}

And don't forget the init function!!!!

(Part Of) Deploying:
2. Setting *.alo files
Place your *.alo files on :

• The plugins/platform_dir of the installation directory ($DTECT_APPL/plugins/$HDIR)


• The '.od' directory in your 'Personal directory' ($HOME/.od/plugins/$HDIR on Unix)

Example of: odmain.xxx.alo <-- this is the "default" file naming format

Annotations
Madagascar
uiMadagascar
CmdDriver
GMT
uiGMT

3. Distribute your plugin files (those *.dll or *.so files)

Further Resources:

• Opendtect Plugin Guide


• The Source Code

OpenDtect (Linux Development Install)

Hi...

1. Install GCC v3.4.6 (g++, gcc-base, cpp, gcc, libstdc++6-dev. ubuntu, hardy)


2. download opendtect binary package and developer source package here


3. chmod downloaded files to executables, run the file, it will extract *tar.gz file into the same directory

   chmod +x [filename]



4. extract to home directory (e.g: /home/someone)

   tar -xf [extracted downloaded files]



5. Install opendtect, setup development environment from

   Utilities > Tools  > Create Devel. Env.



6. Setup IDE (in my case eclipse CDT), Create a new c++ project with existing source, pointing to ODWork directory.


7. Start developing! in plugin folder of ODWork