Metadata-Version: 2.4
Name: subscript
Version: 1.15.0
Summary: Equinor's collection of subsurface reservoir modelling scripts
Author-email: Equinor <rnyb@equinor.com>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/equinor/subscript
Project-URL: Repository, https://github.com/equinor/subscript
Project-URL: Documentation, https://equinor.github.io/subscript
Keywords: energy,subsurface,reservoir,scientific,engineering
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Natural Language :: English
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: resdata
Requires-Dist: res2df
Requires-Dist: ert>=10.2.0b13
Requires-Dist: fmu-tools
Requires-Dist: gaussianfft
Requires-Dist: grid3d_maps
Requires-Dist: jinja2
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: opm>=2023.04
Requires-Dist: pandas>=2
Requires-Dist: pydantic
Requires-Dist: pyscal
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: xtgeo
Provides-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-mpl; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: rstcheck; extra == "tests"
Requires-Dist: rstcheck-core; extra == "tests"
Requires-Dist: ruff; extra == "tests"
Requires-Dist: types-Jinja2; extra == "tests"
Requires-Dist: types-PyYAML; extra == "tests"
Requires-Dist: types-python-dateutil; extra == "tests"
Requires-Dist: pandas-stubs; extra == "tests"
Requires-Dist: types-seaborn; extra == "tests"
Requires-Dist: scipy-stubs; extra == "tests"
Provides-Extra: docs
Requires-Dist: autoapi; extra == "docs"
Requires-Dist: sphinx<9; extra == "docs"
Requires-Dist: sphinx-argparse; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinx_rtd_theme>=3.1.0.rc1; extra == "docs"
Dynamic: license-file

# subscript

[![subscript](https://github.com/equinor/subscript/actions/workflows/subscript.yml/badge.svg)](https://github.com/equinor/subscript/actions/workflows/subscript.yml)
[![codecov](https://codecov.io/gh/equinor/subscript/branch/main/graph/badge.svg)](https://codecov.io/gh/equinor/subscript)
![Python Version](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)
[![License: GPL v3](https://img.shields.io/github/license/equinor/subscript)](https://www.gnu.org/licenses/gpl-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)

**subscript** is Equinor's collection of scripts used for subsurface reservoir modelling.

---

## Quick Reference

* [**Documentation**](https://equinor.github.io/subscript)
* [**Installation**](#installation)
* [**Usage**](#usage)
* [**Contributing**](https://equinor.github.io/subscript/contributing.html)

---

## Installation

subscript can be installed via pip

```sh
pip install subscript
```

## Usage

As a collection of utilities subscript has many different invocations and
use cases. A complete overview can be found in the
[documentation](https://equinor.github.io/subscript)
for a complete overview.

Note that some of these utilities may depend upon commercial third-party
software.


## Developing & Contributing

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


## Documentation

The documentation can be found at https://equinor.github.io/subscript
