Metadata-Version: 2.4
Name: xtgeoviz
Version: 0.3.3
Summary: Plotting library for xtgeo objects
Author-email: Equinor <fg_fmu-atlas@equinor.com>
License-Expression: LGPL-3.0-only
Project-URL: Homepage, https://github.com/equinor/xtgeoviz
Project-URL: Repository, https://github.com/equinor/xtgeoviz
Project-URL: Documentation, https://github.com/equinor/xtgeoviz
Project-URL: Issues, https://github.com/equinor/xtgeoviz/issues
Keywords: energy,subsurface,reservoir,scientific,engineering,maps,xtgeo
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Natural Language :: English
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML
Requires-Dist: matplotlib>=3.3.2
Requires-Dist: numpy
Requires-Dist: scipy>=1.5.3
Requires-Dist: xtgeo>=4.19.0
Provides-Extra: tests
Requires-Dist: coverage>=4.1; extra == "tests"
Requires-Dist: mypy; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
Requires-Dist: pytest-runner; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: rstcheck; extra == "tests"
Requires-Dist: ruff; extra == "tests"
Requires-Dist: types-PyYAML; extra == "tests"
Provides-Extra: docs
Requires-Dist: autoapi; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-argparse; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints<2.4; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
Dynamic: license-file

# xtgeoviz

[![tests](https://github.com/equinor/xtgeoviz/actions/workflows/ci-xtgeoviz.yml/badge.svg)](https://github.com/equinor/xtgeoviz/actions/workflows/ci-xtgeoviz.yml)
![Python Version](https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13.svg)
[![License: LGPL v3](https://img.shields.io/github/license/equinor/fmu-tools)](https://www.gnu.org/licenses/lgpl-3.0)
[![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](https://img.shields.io/pypi/v/xtgeoviz.svg)](https://pypi.org/project/xtgeoviz/)

Utility functions for plotting xtgeo objects.

## Install

xtgeoviz is available from PyPI.

```sh
pip install xtgeoviz
```

## Usage

```python
import xtgeoviz.plot as xtgplot
import xtgeo

surf = xtgeo.surface_from_file("somemap.gri")
xtgplot.quickplot(surf)
```

## Documentation

The documentation can be found at
[https://equinor.github.io/xtgeoviz](https://equinor.github.io/xtgeoviz).

## Developing & Contributing

All contributions are welcome. Please see the
[Contributing document](https://equinor.github.io/xtgeoviz/contributing.html)
for more details and instructions for getting started.

## License

This software is released under the LGPLv3 license.
