Metadata-Version: 2.1
Name: ngi-calculations
Version: 0.1.10
Summary: CPT correlations including commonly used empirical correlations
Author: Julien Hericher
Author-email: Julien.Hericher@ngi.no
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: numpy (>=2.0.0,<3.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: param (>=2.1.0,<3.0.0)
Requires-Dist: pydantic (>=2.7.4,<3.0.0)
Requires-Dist: scipy (>=1.13.1,<2.0.0)
Requires-Dist: structlog (>=24.2.0,<25.0.0)
Description-Content-Type: text/markdown

# Introduction

This repository contains various correlations for CPTs.

# Getting Started

## Installation

`pip install ngi-calculations`

## Usage

You can find a complete example in:
`./examples/basic-cpt-process.py`

## Development

### Dependencies

- poetry

### Installing

```bash
poetry install
```

then activate the virtual environment:

```bash
poetry shell
```

### Nix

If you use nix flakes, you can instead use:

```bash
nix develop .
```

## Run the tests

```bash
pytest-watcher ./
```

## Contribute

Contact NGI Digital to learn how to contribute to this repo

