odpy framework Documentation

odpy is a framework for research and deployment that allows for basic interactions with the OpendTect software and database

• Locates/set the path to the OpendTect installation

• Locates/set the path to the OpendTect database

• Complements h5py for an easier manipulation of hdf5 attributes

• Easy loading of well logs from the OpendTect database

Installation

With pipenv - https://docs.pipenv.org:

pipenv install git+https://github.com/OpendTect/odpy.git#egg=odpy

With pip - https://pip.pypa.io/en/stable/

pip3 install git+https://github.com/OpendTect/odpy.git

After that just import odpy:

import odpy

To get the developer version, run:

git clone --recursive https://github.com/OpendTect/odpy.git

Citing odpy

Please cite odpy in your publications if it helps your research.:

 Huck A., and Ibrahim O. odpy library for OpendTect access. 2019.

 @misc{odpy_2019,
     author       = {A. Huck and O. Ibrahim},
     title        = {odpy library for OpendTect access},
     year         = 2019
}

Contents:

• API Reference
  • odpy
    • Submodules
      • odpy.browse_hdf5_seis
        • Attributes
        • Module Contents
          • filenm
          • filebasenm
          • si
          • attribinfo
          • samplinginfo
          • datatkzs
          • axes
          • blocksinfo
          • blocksrg
          • usrinp
          • compnms
          • attribnm
          • nrcomps
          • cont
          • slicesel
          • h5file
          • cubepos
      • odpy.cmddriver
        • Attributes
        • Functions
        • Module Contents
          • driverexe
          • doScript()
          • hasError()
      • odpy.common
        • Module Summary
          • KEY methods
          • Example
        • Attributes
        • Classes
        • Functions
        • Module Contents
          • sTimeUnitString()
          • logconfig
          • syslog_logger
          • proclog_logger
          • handler
          • handler
          • initLogging()
          • set_log_file()
          • get_log_logger()
          • get_std_logger()
          • mergeArgs()
          • std_msg()
          • log_msg()
          • has_file_handlers()
          • has_stdlog_file()
          • has_log_file()
          • get_handler_stream()
          • get_handler_filename()
          • get_std_stream()
          • get_log_stream()
          • get_stdlog_file()
          • get_log_file()
          • reset_log_file()
          • storedstdout
          • storedstderr
          • redirect_stdout()
          • restore_stdout()
          • isWin()
          • isLux()
          • isMac()
          • isPossibleODSoftwareDir()
          • getODSoftwareDir()
          • findODSoftwarePath()
          • BuildConfig
          • getExecPlfDir()
          • getLibPlfDir()
          • get_settings_dir()
          • get_settings_filename()
          • get_base_datadir()
          • get_surveydir()
          • get_data_dir()
          • add_user_dtectdata()
          • add_user_survey()
          • getODArgs()
          • getIconFp()
          • tail()
          • batchIsFinished()
          • writeFile()
          • Timer
      • odpy.dbman
        • Functions
        • Module Contents
          • getSurvey()
          • getDBList()
          • getInfoFromDBListByNameOrKey()
          • getInfoByName()
          • getInfoByKey()
          • getByName()
          • getDBKeyForName()
          • getFileLocation()
          • getNewEntryFileName()
          • removeEntry()
          • isPresent()
      • odpy.gpuinfo
        • Module Summary
        • Functions
        • Module Contents
          • is_cuda_available()
          • detect_gpus()
          • nr_gpus()
          • compute_capability()
          • id()
          • name()
          • get_memory_info()
      • odpy.hdf5
        • Module Summary
          • KEY methods
          • Example
        • Attributes
        • Functions
        • Module Contents
          • dGBInfoDSName
          • openFile()
          • getInfoDataSet()
          • ensureHasDataset()
          • getAttr()
          • setAttr()
          • hasAttr()
          • getAttrs()
          • getText()
          • setArray()
          • getBoolValue()
          • getIArray_()
          • getIntValue()
          • getIInterval()
          • getIStepInterval()
          • getIArray()
          • getDArray_()
          • getDValue()
          • getDInterval()
          • getDStepInterval()
          • getDArray()
          • getAttribInfo()
          • getTransform()
          • getSurveyInfo()
      • odpy.horman
        • Functions
        • Module Contents
          • create_horizon_file()
      • odpy.iopar
        • IOPar tools
        • Functions
        • Module Contents
          • read_line()
          • read_from_iopar()
      • odpy.oscommand
        • Functions
        • Module Contents
          • getODCommand()
          • appendDtectArgs()
          • getEnvForOpendTect()
          • getPythonExecNm()
          • getPythonCommand()
          • execCommand()
          • isRunning()
          • pauseProcess()
          • resumeProcess()
          • printProcessTime()
          • kill()
          • startAndWait()
          • log_subprocess_output()
          • startDetached()
      • odpy.ranges
        • Module Summary
          • KEY methods
        • Functions
        • Module Contents
          • get_range()
          • arrayFromRange()
          • get_range_steps()
          • getLineObj()
          • getTraceObj()
          • getZObj()
          • getAxesAsRanges()
          • getAxesAsArrays()
          • getIntervalStr()
          • printSampling()
          • niceNumber()
          • niceRange()
      • odpy.seisman
        • Attributes
        • Functions
        • Module Contents
          • seistrlgrp
          • dblist
          • getSeismicDBList()
          • getName()
          • getDBKey()
          • get_file_location()
          • isPresent()
          • show_line()
          • ConvertSegy2Numpy()
      • odpy.test_ioserv
        • Module Summary
        • Attributes
        • Functions
        • Module Contents
          • inpstrm
          • outstrm
          • dbg_pr()
          • put_to_output()
          • get_from_input()
          • mk_int_bytes()
          • get_int_from_bytes()
          • outvals
          • data_read
      • odpy.volpreload
        • Functions
        • Module Contents
          • getAxes()
          • preLoad()
      • odpy.wellman
        • Module Summary
        • Attributes
        • Functions
        • Module Contents
          • wlltrlgrp
          • dblist
          • getNames()
          • getInfo()
          • getName()
          • getLogNames()
          • getLog()
          • getLogs()
          • getDBKey()
          • getWellDBList()
          • getMarkers()
          • getTrack()
    • Attributes
    • Package Contents
      • __version__

Indices and tables

• Index

• Module Index