Metadata-Version: 2.1
Name: olas
Version: 0.2.0
Summary: Library with wave tools like ESTELA
Home-page: https://github.com/jorgeperezg/olas
License: MIT
Keywords: waves,xarray,ESTELA
Author: jorge.perez
Author-email: j.perez@metocean.co.nz
Requires-Python: >=3.8,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: cartopy (>=0.21.1,<0.22.0)
Requires-Dist: dask[complete] (>=2023.3.1,<2024.0.0)
Requires-Dist: matplotlib (>=3.7.1,<4.0.0)
Requires-Dist: netcdf4 (>=1.6.3,<2.0.0)
Requires-Dist: numpy (>=1.24.2,<2.0.0)
Requires-Dist: scipy (>=1.10.1,<2.0.0)
Requires-Dist: xarray (>=2023.1.0,<2024.0.0)
Project-URL: Documentation, https://jorgeperezg.github.io/olas/estela.html
Project-URL: Repository, https://github.com/jorgeperezg/olas
Description-Content-Type: text/markdown

# olas

[![pypi package
version](https://img.shields.io/pypi/v/olas.svg)](https://pypi.python.org/pypi/olas)
[![conda-forge
version](https://img.shields.io/conda/vn/conda-forge/olas.svg)](https://anaconda.org/conda-forge/olas)
[![python supported
shield](https://img.shields.io/pypi/pyversions/olas.svg)](https://pypi.python.org/pypi/olas)

Library with wave tools. At the moment it only includes a prototype of ESTELA.

Documentation: <https://jorgeperezg.github.io/olas>

The documentation is generated with `poetry run portray on_github_pages`

## Installation

Installation with conda is straightforward
```
conda install -c conda-forge olas
```

Installation with pip requires cartopy (it can be installed with `conda install -c conda-forge cartopy`):
```
pip install olas
```

## Basic usage
Calculate and plot ESTELA maps from netcdf files.

```
from olas.estela import calc, plot
estelas = calc("./tests/sample_files/test20180101T??.nc", 44, -4, "hs", "tp", "dp")
plot(estelas, outdir=".")
plot(estelas, gainloss=True, outdir=".")
```

