| OpendTect Application Management Documentation version 4.2 |
|---|
| Prev |
|
Next
|
In INSTALL.txt, the installation procedure is described. On Windows, you need to download one or more self-extracting executables. On UNIX-type systems, you may have to download a script: install.od or inst_pkgs.od. All scripts take no arguments and should be easy to complete. Please read INSTALL.txt carefully.
Regarding the selection of installation directory, you should choose a directory that is accessible on all machines that will run OpendTect (or one of its batch programs). This is especially important for multi-machine processing (which is indispensable for surveys of considerable size). Every machine that needs to be used for this multi-machine processing needs to be able to access OpendTect under the same directory name.
Many commercial plugins for OpendTect use FlexLM licensing. The FlexLM end-user manual can be found at http://opendtect.org/lic/endusermanual.
The main source of information from opendtect.org is http://opendtect.org/lic/flexlm_installation_guide.html.
Some hints. There are two types of licenses: 'node-locked' and 'floating'. A node-locked license is locked to a certain machine. Node-locked licenses have only got lines like this:
FEATURE dTectNN lm_dgb 4.200 1-jan-2013 uncounted C42442D673EF
HOSTID=000039eb8bda
FEATURE dTectDS lm_dgb 4.200 1-jan-2013 uncounted 766915A97FB6
HOSTID=000039eb8bda
Also demo licenses (these have HOSTID=DEMO but look the same) are handled like this.
Another kind of license files require a machine designated as license server. On this machine, a daemon (UNIX) or service (Windows) will keep track of the licenses available. These are typically used when OpendTect can run on multiple computers. These license files look like this:
SERVER ourserv 000c6e00bbb8
DAEMON lm_dgb full_path_to/lm_dgb
FEATURE dTectDS lm_dgb 4.200 1-jan-2013 4 B47BBC613640 DUP_GROUP=D
FEATURE dTectNN lm_dgb 4.200 1-jan-2013 4 3FC4443E7619 DUP_GROUP=D
The file is read like this: FlexLM needs to start a server on machine 'ourserv' with FlexLM host ID 000c6e00bbb8. To start this server, use a program lm_dgb(.exe). Until 1-aug-2008 you can use 'dTectDS' and 'dTectNN' with 4 concurrent users, version 4.2 and lower.
The normal way to specify a FlexLM license file on Windows is to simply start OpendTect. If you did not specify a license file yet, OpendTect will ask for one. Simply follow the instructions on the screen. Sometimes, this doesn't work (for example if you want to use another license file). Then you can use the FlexLM utility program available in the Windows start menu for OpendTect: 'License Manager Tools' (LMTOOLS.exe).
Everything should be manageable from this program, although things can be a little confusing. If you need to install on a Windows server, you should really take a look at http://opendtect.org/lic/flexlm_installation_guide.html, in particular http://opendtect.org/lic/flexlm_inst_win.html. The main choice you have is whether you need to install using services or with a license file. Which of the two depends on the license file you have got and the machine you are on. If you have a node-locked license, you always have to choose to set up using a license file. Also demo licenses (where HOSTID=DEMO) and machines that are not designated to be SERVER of a floating license. In the start tab, select 'Configuration using License file'. You can then select the file to use, but that often doesn't work. Then go to the 'Utilities' tab and enter Vendor Name lm_dgb and select the path to the license file. Then press 'Override Path'.
If you have a floating license, you must start the service on the machine mentioned in the header of the license file. On that machine, start the License manager Tools. In the start tab, select 'Configuration using services'. Then click the 'Config Services' tab (which has now appeared). Enter a name for the service, for example 'OD-dGB lic man'. Confusing here is that the combo box is an editable field. You have to find the path to the lmgrd.exe. This may be vendor-specific, for example, dGB has all license-related files in a directory: C:Program FilesOpendTectbinwinlm.dgb The path to the license file is something you have chosen yourself (for example in C:Licenses), and the normally the debug log file can be placed in the same directory. Now, you can press the 'Save service' button. Then, you can start the service in the Start/Stop/Reread tab. If you want to run OpendTect from another computer, you need to copy the license file to that computer, and use the same utility. Now, go to the 'Utilities' tab and enter Vendor Name lm_dgb and select the path to the license file. Then press 'Override Path'. That should be enough to make the computer find the license manager service on the remote machine.
For simple node-locked and demo licenses, there is also a menu in OpendTect, for end-users.
1.2.2.1.1. Installation using a license file
Your main source of information is http://opendtect.org/lic/flexlm_inst_win.html.
Very often you just need to install a new license file. Then, on the local machine, you can use the license manager tools to specify/override the license file OD is supposed to look at. Once you have fired up the "License Manager Tools", you can see a tab "Utilities". That one contains a button "List All Vendor Paths". There you can see that there is a path "lm_dgb", which is the one used by OpendTect. You can override this, if you
- enter lm_dgb in the "vendor name" field
- click the "..." button and select a license file
- press the "Override Path" button
If you want to share a common site license amongst multiple users and/or hosts, you can install the Flexlm license manager as a Windows service -- the equivalent of Unix daemons. However, this does not work for demo licenses. These have to be installed on the local host.
Note 1: One not so obvious thing is that in the 'Config services' tab, the 'Service name' combobox is editable.
Note 2: If OD complains, it might be that the console window contains some info about what is wrong.
Your main source of information is http://opendtect.org/lic/flexlm_inst_unix.html.
Some remarks. Make sure you work under the same user that installed OpendTect. The 'start.vendor_name.lmgrd' scripts can be used when you have no company policy on start/stop of FlexLM daemons. The script takes one optional argument; if this argument is 'stop' then the daemon(s) will be stopped rather than started. If the 'start' mode is used, the output of the daemons is redirected to license.package_name.log.
For every commercial plugin package you should find a UNIX script 'install.package_name.license' in the installation directory that reads obtained license files and writes those to the correct position in the OpendTect tree. If you have your own FlexLM management procedures (e.g. FlexAdmin), you still have to make sure that a file 'license.package_name.dat' is present in the application directory containing the necessary license information.
The FlexLM end-user manual can be found at http://opendtect.org/lic/endusermanual.
The two things needed by your plugin vendor to issue a license are the hostname, obtainable on UNIX with the 'hostname' command (Windows: Start-Settings-Control panel-System, tab Network identification), and the host identification. That identification can be obtained by running the FlexLM utility 'lmhostid'. After installing OpendTect, the lmhostid command can be run from the Utilities-BatchPrograms menu.
It is, in general, possible to obtain the FlexLM hostid before installing OpendTect:
Table 1-2. FlexLM IDs
| Solaris | hostid |
| Linux | /sbin/ifconfig' look for 'HWAddr', i.e. the MAC address of the main network card |
| Mac OS X | /sbin/ifconfig look for 'ether' - the MAC address of the main network card |
| MS Windows | Run ipconfig /all in a DOS ('command prompt') window and look for each 'Physical address' entry, choose the main network MAC address. |
For license files, additionally the host name will be required, although host names can be changed at any time. On UNIX, this is simply the output of hostname, on Windows the 'Host Name' from the ipconfig /all is required.
The main script the user will need to run is 'start_dtect' in the installation root. Some power-users will also want to run the 'exec_prog' script (to start specific command-line or batch utilities). Essentially, start_dtect takes no arguments but arguments given will be passed to the od_main executable, which is a standard (X-)Windows and Qt application. The exec_prog script will always have a first argument, which is the program to be executed. The rest of the arguments will be passed to the program.
If you have the GNU debugger installed (gdb), then users will be able to send crash reports to opendtect.org for feedback. This can be highly useful to solve problems for users.
The program scripts are called from within OpendTect or the OpendTect startup scripts. Remote execution is always done through od_exec_rmt (UNIX only), local execution through od_exec.
The OpendTect executables are dynamically linked against the shared libraries in the so/ subdirectory. Bug fixes or special-purpose updates usually consist of a replacement in this directory.
Data files for the OpendTect programs are located in the 'data' subdirectory. If you want to overrule certain defaults like a custom default empty survey, or standard color bars, then you can make changes in this directory. Note that you have to make these changes in every update or re-install.
In the data sub directory in the installation directory you will find a file BatchHosts_example. It is easy to see how to use this file as an example of a BatchHosts file. If you do not place such a BatchHosts file in a location specified in the data locations section, OpendTect will ask the Operating System for remote host names (via the g/sethostent() type functions). This can result in a lot of choices for the user, or none. The following constraints apply:
The host must accept 'rsh', 'ssh' or (win32) 'rcmd', which can be specified in the BatchHosts file. Passwords cannot be passed directly to the shell. However on windows passwords are required in order to enable access to the windows data shares and also for rcmd access; these are handled by "net use".
See also the section on remote batch processing. Make sure remote machines need to have a well synchronized system time.
About the 'First port' entry: the multi-machine processing processing needs a free TCP port to do its work. It starts at a port number which is used if it's free. If not, the program will try one higher and so forth. The starting port is by default set to 19636. If this clashes with any application (that means if that other application is not flexible in its port allocation), overrule it.
The name of the BatchHosts file can be overridden using the environment variable DTECT_BATCH_HOSTS_FILENAME. You can also specify a filename + full path using the DTECT_BATCH_HOSTS_FILEPATH environment variable.
The ColTabs file in the data directory contains the default color tables that every new user will get. The user can never remove these tables, but (s)he can change the definition (only in their own environment). The format of the file is quite simple. The only thing to explain is the concept. A color table is seen as a series of colors (RGB, optional transparency) on a fictive measure of 0 to 1. Every color table needs a definition of the values 0 and 1, but more colors can be defined in between. For example, the well-known Red-white-black color scale is defined as:
2.Name: Red-White-Black
2.Value-Color.1: 0`255`0`0
2.Value-Color.2: 0.25`255`200`0
2.Value-Color.3: 0.5`255`255`255
2.Value-Color.4: 1`0`0`0
2.Transparency.0: 0`0
2.Transparency.1: 1`0
2.Undef color: 150`200`150
2.Marker color: 0`240`0
On six lines, you see the definition of colors, format Red`Green`Blue (separated by back-quotes). On the Value-Color lines, these are preceded by the position in the color table, here 0, 0.25, 0.5, and 1. In the above example there is no transparency; a simple 'full transparency in the middle' example would be:
2.Transparency.0: 0`0
2.Transparency.1: 0.5`1
2.Transparency.2: 1`0
The default user settings are copied to the user's home directory when the user starts OpendTect for the very first time. The file format is straightforward, for details about what the entries mean exactly, please contact OpendTect support.
A selection of system utilities and OpendTect batch programs will be available to the OpendTect user through the user interface. This file defines which ones are available, what parameters must be passed and provides info on the programs. Also here the file format is straightforward, for details about what the entries mean exactly, please contact OpendTect support.
A list of standard mouse button bindings have been compiled in the MouseControls file. The user can select one of these setups in OpendTect. If more setups are needed, add those to this file. Even the 'new user' default can be set. The Default: 'Default' is the OpenInventor default which is also adopted by Landmark.
The attribute sets in this directory are available to users as initial sets. In principle, any set created by any user can be placed in this directory to make it available for all OpendTect users. This requires one extra step, however: addition to the Object Management File (.omf). The .omf file needs to be edited with at text editor; an entry similar to the existing ones should be added, but with another ID on the first line of the entry. Alternatively, you can copy the entry as it appears in the .omf in the user's project's Attribs subdirectory's .omf .
Plugins can put their own default attribute set in xxAttrib subdirectories. OpendTect will scan for such directories automatically.
This directory is copied in its entirety when a user creates a new survey (i.e. a new project). Like all OpendTect surveys, the directory can be copied on the UNIX or Windows level (note: make sure hidden files are copied, too!). Therefore, companies can customize and extend initial survey contents by changing/adding to this survey.
The OpendTect documentation - if installed - can be reached from inside OpendTect via the Help menu. From outside OpendTect, index.html in the directory doc/User/base can be opened. For printing, PDF files may be available on the opendtect.org web site.
Documentation for plugin packages may also be present in the doc/User directory. The name of such a directory should be package_name, and a '.mnuinfo' file is mandatory. This file contains the menu name, start url and optional a shortcut.
Open the file 'about.html' for version and contributors to the OpendTect project.