Metadata-Version: 2.2
Name: xtgeo
Version: 4.16.2
Summary: XTGeo is a Python library for 3D grids, surfaces, wells, etc
Keywords: grids,surfaces,wells,cubes
Author-Email: Equinor <fg_fmu-atlas@equinor.com>
License: LGPL-3.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Project-URL: Homepage, https://github.com/equinor/xtgeo
Project-URL: Repository, https://github.com/equinor/xtgeo
Project-URL: Issues, https://github.com/equinor/xtgeo/issues
Project-URL: Documentation, https://xtgeo.readthedocs.io
Requires-Python: >=3.10
Requires-Dist: deprecation
Requires-Dist: gstools
Requires-Dist: h5py>=3
Requires-Dist: hdf5plugin>=2.3
Requires-Dist: joblib
Requires-Dist: matplotlib>=3.3
Requires-Dist: numpy
Requires-Dist: pandas<3.0.0,>=1.1
Requires-Dist: pyarrow
Requires-Dist: resfo>=5
Requires-Dist: roffio>=0.0.2
Requires-Dist: scipy>=1.5
Requires-Dist: segyio>1.8.0
Requires-Dist: shapely>=1.6.2
Requires-Dist: tables
Requires-Dist: typing_extensions
Requires-Dist: xtgeoviz
Provides-Extra: dev
Requires-Dist: clang-format; extra == "dev"
Requires-Dist: cmake-format; extra == "dev"
Requires-Dist: coverage>=4.1; extra == "dev"
Requires-Dist: hypothesis; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"
Requires-Dist: psutil; extra == "dev"
Requires-Dist: pydocstyle; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-benchmark; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: pytest-runner; extra == "dev"
Requires-Dist: pytest-snapshot; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: autoclasstoc; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: pydocstyle; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinx-tabs<3.4.5; extra == "docs"
Requires-Dist: sphinx-toolbox>=3.5.0; extra == "docs"
Description-Content-Type: text/markdown

![XTGeo](https://github.com/equinor/xtgeo/blob/main/docs/images/xtgeo-logo-wide.png)
![builds](https://github.com/equinor/xtgeo/workflows/builds/badge.svg)
![linting](https://github.com/equinor/xtgeo/workflows/linting/badge.svg)
[![codecov](https://codecov.io/gh/equinor/xtgeo/branch/main/graph/badge.svg)](https://codecov.io/gh/equinor/xtgeo)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![PyPI version](https://badge.fury.io/py/xtgeo.svg)](https://badge.fury.io/py/xtgeo)
[![Documentation Status](https://readthedocs.org/projects/xtgeo/badge/?version=latest)](https://xtgeo.readthedocs.io/en/latest/?badge=latest)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xtgeo.svg)
![PyPI - License](https://img.shields.io/pypi/l/xtgeo.svg)

## 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](https://xtgeo.readthedocs.io)

## Feature summary

-   Python 3.10+ 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](https://github.com/equinor/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 for all three platforms 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

```python
import xtgeo

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

print(f"Mean is {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.
