equinor/xtgeo

xtgeo-master
- src
  - xtgeo
    - plot
      - _colortables.py
      - xsection.py
      - xtmap.py
      - __init__.py
      - baseplot.py
      - grid3d_slice.py
    - well
      - wells.py
      - _well_oper.py
      - _well_roxapi.py
      - _well_io.py
      - _wellmarkers.py
      - sample.txt
      - blocked_wells.py
      - blocked_well.py
      - _blockedwells_roxapi.py
      - well1.py
      - _wells_utils.py
      - __init__.py
      - _blockedwell_roxapi.py
      - example.txt
    - common
      - xtgeo_dialog.py
      - exceptions.py
      - calc.py
      - constants.py
      - __init__.py
      - sys.py
    - grid3d
      - _gridprop_lowlevel.py
      - _grid3d_utils.py
      - _grid_export.py
      - grid_property.py
      - _gridprop_import.py
      - _grid_roff_lowlevel.py
      - _grid_import_ecl.py
      - _grid_wellzone.py
      - grid.py
      - _grid_import_roff.py
      - _gridprop_import_grdecl.py
      - _grid_etc1.py
      - grid_properties.py
      - _grid_refine.py
      - _gridprop_import_roff.py
      - _gridprops_etc.py
      - _grid_roxapi.py
      - _grid3d.py
      - _grid_eclbin_record.py
      - _gridprop_import_eclrun.py
      - __init__.py
      - _gridprop_etc.py
      - _gridprop_op1.py
      - _grid_hybrid.py
      - _gridprop_export.py
      - _grid3d_fence.py
      - _grid_import.py
      - _gridprop_roxapi.py
      - _gridprops_io.py
    - __init__.py
    - cxtgeo
      - __init__.py
    - surface
      - _regsurf_roxapi.py
      - _regsurf_gridding.py
      - regular_surface.py
      - _surfs_import.py
      - _regsurf_cube_window_v2.py
      - _regsurf_import.py
      - surfaces.py
      - _regsurf_cube_window.py
      - _regsurf_export.py
      - _regsurf_cube.py
      - _regsurf_lowlevel.py
      - _regsurf_oper.py
      - _regsurf_grid3d.py
      - __init__.py
      - _regsurf_utils.py
    - roxutils
      - _roxutils_etc.py
      - __init__.py
      - roxutils.py
    - cube
      - _cube_utils.py
      - cube1.py
      - _cube_roxapi.py
      - __init__.py
      - _cube_export.py
      - _cube_import.py
    - xyz
      - _xyz_roxapi.py
      - polygons.py
      - _xyz_io.py
      - _xyz.py
      - _xyz_oper.py
      - __init__.py
      - points.py
      - _xyz_lowlevel.py
  - clib
    - cxtgeo.i
    - numpy.i
    - xtg
      - grd3d_make_z_consistent.c
      - grd3d_imp_roffbin_xvec.c
      - x_vector_info.c
      - grd3d_calc_dz.c
      - x_3d_polyhedron.c
      - x_conv_vformats.c
      - grd3d_adj_cells.c
      - well_trunc_parallel.c
      - grd3d_roff2xtgeo_zcorn.c
      - x_ib2ijk.c
      - grd3d_imp_ecl_egrid.c
      - surf_import_ijxyz_tmpl.c
      - grd3d_geometrics.c
      - x_mapaxes.c
      - surf_slice_cube_v2.c
      - grdcp3d_corners.c
      - cube_value_xyz_interp.c
      - surf_export_zmap_ascii.c
      - grd3d_well_ijk.c
      - cube_resample_cube.c
      - surf_xyori_from_ij.c
      - surf_export_irap_bin.c
      - cube_import_segy.c
      - grd3d_imp_prop_roffbin.c
      - x_ijk2ib.c
      - surf_resample.c
      - grd3d_calc_dxdy.c
      - grd3d_get_randomline.c
      - x_swap_endian.c
      - grd3d_collapse_inact.c
      - surf_setval_poly.c
      - grd3d_setval_poly.c
      - x_diff_angle.c
      - surf_get_dist_values.c
      - sucu_ij_from_xy.c
      - surf_get_z_from_ij.c
      - surf_sample_grd3d_lay.c
      - x_linint3d.c
      - x_statistics.c
      - grd3d_read_eclrecord.c
      - grd3d_midpoint.c
      - xtg.h
      - grd3d_inact_outside_pol.c
      - grd3d_import_grdecl_prop.c
      - x_general.c
      - cube_xy_from_ij.c
      - header.txt
      - swap_endian.h
      - surf_import_irap_ascii.c
      - grd3d_zminmax.c
      - cube_import_storm.c
      - cube_value_xyz_cell.c
      - grd3d_export_roff_prop.c
      - grd3d_export_grdecl.c
      - grd3d_translate.c
      - grd3d_write_free_eclinput.c
      - grd3d_convert_hybrid.c
      - grd3d_refine_vert.c
      - cube_value_ijk.c
      - x_roffbin_utils.c
      - x_cmp_sort.c
      - x_vector_linint.c
      - cube_export_segy.c
      - .clang-format
      - grdcp3d_imp_roff_coordsv.c
      - surf_stack_slice_cube.c
      - grd3d_crop_geometry.c
      - x_interp_map_nodes.c
      - well_geometrics.c
      - surf_import_ijxyz.c
      - x_vector_linint1d.c
      - grd3d_write_eclrecord.c
      - surf_cube_attr_intv.c
      - surf_export_storm_bin.c
      - x_vector_linint3.c
      - grd3d_write_eclinput.c
      - grd3d_export_grdeclprop2.c
      - surf_export_irap_ascii.c
      - x_nint.c
      - surf_get_zv_from_xyv.c
      - grd3d_export_roff_end.c
      - surf_xy_as_values.c
      - grd3d_scan_roffbinary.c
      - grd3d_from_cube.c
      - x_verify_vectorlengths.c
      - libxtg_.h
      - surf_import_petromod_bin.c
      - x_vector_linint2.c
      - grdcp3d_imp_roffbin_prop_xvec.c
      - grd3d_reduce_onelayer.c
      - grd3d_export_grdeclprop.c
      - cube_scan_segy_hdr.c
      - cube_import_rmsregular.c
      - surf_export_irap_bin_test.c
      - grd3d_conv_grid_roxapi.c
      - well_surf_picks.c
      - verify_tmp.txt
      - grd3d_point_val_crange.c
      - x_avg_angles.c
      - grd3d_get_all_corners.c
      - grd3d_ecl_tsteps.c
      - grd3d_scan_eclbinary.c
      - surf_export_petromod_bin.c
      - surf_xyz_from_ij.c
      - grd3d_copy.c
      - grd3d_conv_roxapi_grid.c
      - cube_export_rmsregular.c
      - grd3d_import_grdecl.c
      - cube_ijk_from_xyz.c
      - cube_vertical_val_list.c
      - x_3d_geom2.c
      - x_chk_point_in_hexahedron.c
      - grd3d_inact_by_dz.c
      - grd3d_imp_roffbin_ilist.c
      - surf_swapaxes.c
      - surf_slice_cube.c
      - x_interp_cube_nodes.c
      - grd3d_get_lay_slice.c
      - polys_chk_point_inside.c
      - pol_geometrics.c
      - x_3d_geom.c
      - surf_zminmax.c
      - grd3d_roff2xtgeo_actnum.c
      - xtg_io.c
      - surf_slice_cube_v3.c
      - grd3d_export_roff_grid.c
      - surf_slice_cube_window.c
      - grdcp3d_imp_roff_zcornsv.c
      - libxtg.h
      - grd3d_reverse_jrows.c
      - x_fopen.c
      - logger.h
      - pol_do_points_inside.c
      - surf_get_z_from_xy.c
      - x_swap_check.c
      - pol_chk_point_inside.c
      - x_memory.c
      - cube_coord_val_ijk.c
      - x_2d_rect_corners.c
      - grd3d_roff2xtgeo_coord.c
      - grd3d_check_cell_splits.c
      - x_rotation_conv.c
      - surf_export_ijxyz.c
      - grd3d_calc_xyz.c
      - x_chk_point_in_cell.c
      - grd3d_import_roffbin_data.c
      - cube_swapaxes.c
      - grdcp3d_xtgformat2to1_geom.c
      - grd3d_points_ijk_cells.c
      - logger.c
      - grd3d_export_roff_pstart.c
      - surf_import_irap_bin.c
      - grd3d_zcorn_convert.c
      - grd3d_point_in_cell.c
      - grd3d_export_egrid.c
      - grd3d_corners.c
      - grd3d_imp_roffbin_arr.c
      - surf_slice_grd3d.c
      - cube_get_randomline.c
    - CMakeLists.txt
    - cxtgeo_fake.py
- .coveragerc
- .thirdparty
  - README
- examples
  - surf_threading.py
  - multiprocess_surfs.py
  - grid3d_properties_qc.py
  - grid3d_crop.py
  - grid3d_compute_stats.py
  - regsurf_compute_stats.py
  - wellpath_fence_sample.py
  - surface_slice_grid3d.py
  - surface_slice_cube.py
  - grid3d_print_init_csv.py
  - grid3d_get_df.py
- HISTORY.md
- .readthedocs.yml
- .appveyor.yml
- .pylintrc
- setup.py
- LICENSE.md
- bandit.yml
- CMakeLists.txt
- setup.cfg
- .travis.yml
- README.md
- tests
  - test_surface
    - test_regular_surface_bytesio.py
    - test_regular_surface_vs_grd3d.py
    - test_regular_surface.py
    - test_regular_surface_in_other.py
    - test_surface_cube_attrs.py
    - test_regular_surface_vs_points.py
    - test_regular_surface_resample.py
    - test_regular_surface_vs_cube.py
    - __init__.py
    - test_forks.py
    - test_regular_surface_roxapi.py
    - test_surfaces.py
  - jupyter
    - xtgeo1.ipynb
    - README.MD
  - test_plot
    - test_xsection.py
    - test_colortables.py
    - test_map.py
    - test_grid3dsliceplot.py
    - __init__.py
    - test_grid3dlayerplot.py
  - test_well
    - test_well_to_points.py
    - test_well_vs_grid.py
    - test_well_to_polygons.py
    - test_blockedwell_roxapi.py
    - test_well.py
    - test_well_vs_surface.py
    - __init__.py
    - test_blockedwell.py
    - test_well_roxapi.py
    - test_blockedwells_roxapi.py
    - test_wells.py
  - test_grid3d
    - test_grid_properties.py
    - test_grid.py
    - test_grid_vs_points.py
    - test_grid_operations.py
    - test_grid_fence.py
    - test_grid_dualporo.py
    - test_grid_property_roxapi.py
    - test_grid_property.py
    - test_grid_roxapi_bigtest.py
    - test_grid_roxapi.py
    - __init__.py
    - test_grid_vs_poly.py
    - test_grid_vs_well.py
  - test_etc
    - test_etc_make_hcpv_maps.py
    - __init__.py
    - test_etc_make_avg_maps.py
  - test_xyz
    - test_polygons_from_wells.py
    - test_points_from_wells.py
    - test_points_vs_other.py
    - __init__.py
    - test_points_poly.py
  - test_common
    - test_calc.py
    - __init__.py
    - test_xtg.py
    - test_system.py
  - test_cube
    - __init__.py
    - test_cube.py
  - test_roxutils
    - test_roxutils.py
  - conftest.py
- scripts
  - manylinux_docker.sh
  - config.sh
  - appv_example1.yml
  - swig_install.sh
  - requirements_appveyor.txt
  - build-wheels.sh
  - pyproject.toml.komodo
  - requirements_komodo.txt
  - requirements_setup.txt
- pyproject.toml
- requirements.txt
- .gitignore
- docs
  - history.rst
  - Makefile
  - make.bat
  - images
    - datamodel_regsurface.svg
    - zone-well-mismatch.svg
    - xtgeo-logo-wide.svg
    - xtgeo-logo3.svg
    - xtgeo-logo.svg
    - zone-well-mismatch-plain.svg
    - xtgeo-logo2.svg
    - .gitignore
  - usage.rst
  - usextgeoroxar.rst
  - readme.rst
  - datamodels.rst
  - authors.rst
  - requirements.txt
  - index.rst
  - conf.py
  - contributing.rst
  - installation.rst
- requirements_dev.txt

PyPI - Python Version PyPI - License

Introduction

XTGeo is a LGPL licensed Python library with C backend to support manipulation of (oil industry) subsurface reservoir modelling. Typical users are geoscientist and reservoir engineers working with reservoir modelling, in relation with RMS. XTGeo is developed in Equinor.

Detailed documentation for XTGeo at Read the Docs

Feature summary

Python 2.7+ and 3.5+ support
Focus on high speed, using numpy and pandas with C backend
Regular surfaces, i.e. 2D maps with regular sampling and rotation
3D grids (corner-point), supporting several formats such as RMS and Eclipse
Support of seismic cubes, using segyio as backend for SEGY format
Support of well data, line and polygons (still somewhat immature)
Operations between the data types listed above; e.g. slice a surface with a seismic cube
Optional integration with ROXAR API python for several data types (see note later)
Linux is main development platform, but Windows and MacOS (64 bit) are supported and PYPI wheels are provided.

Installation

For Linux, Windows and MacOS 64bit, PYPI installation is enabled:

pip install xtgeo

For detailed installation instructions (implies C compiling), see the documentation.

Getting started

from xtgeo.surface import RegularSurface

# create an instance of a surface, read from file
mysurf = RegularSurface("myfile.gri")  # Irap binary as default

print("Mean is {}".format(mysurf.values.mean()))

# change date so all values less than 2000 becomes 2000
# The values attribute gives the Numpy array

mysurface.values[mysurface.values < 2000] = 2000

# export the modified surface:
mysurface.to_file("newfile.gri")

Note on RMS Roxar API integration

The following applies to the part of the XTGeo API that is connected to Roxar API (RMS):

RMS is neither an open source software nor a free software and any use of it needs a software license agreement in place.