Metadata-Version: 2.4
Name: olas
Version: 0.4.0
Summary: Library with wave tools like ESTELA
Keywords: waves,xarray,ESTELA
Author: Jorge Perez
Author-email: Jorge Perez <j.perez@metocean.co.nz>
License-Expression: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3.14
Requires-Dist: xarray>=2023.1.0
Requires-Dist: dask[dataframe,diagnostics,distributed]>=2023.3.1
Requires-Dist: scipy>=1.10.1
Requires-Dist: numpy>=1.24.2
Requires-Dist: matplotlib>=3.7.1
Requires-Dist: netcdf4>=1.6.3
Requires-Dist: cartopy>=0.21.1
Requires-Dist: pytest>=7.2.2 ; extra == 'dev'
Requires-Dist: ipython>=8.11.0 ; extra == 'dev'
Requires-Dist: ipdb>=0.12.3 ; extra == 'dev'
Requires-Dist: prek>=0.2 ; extra == 'dev'
Requires-Dist: mkdocs-material>=9 ; extra == 'dev'
Requires-Python: >=3.9, <3.15
Project-URL: documentation, https://jorgeperezg.github.io/olas
Project-URL: homepage, https://github.com/jorgeperezg/olas
Project-URL: repository, https://github.com/jorgeperezg/olas
Provides-Extra: dev
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>

## Installation

Installation from [PyPI](https://pypi.org/project/olas/) with pip (or similar tools) is straightforward:
```
pip install olas
```

It can also be installed with conda from [conda-forge](https://anaconda.org/conda-forge/olas) ([feedstock](https://github.com/conda-forge/olas-feedstock)):
```
conda install -c conda-forge olas
```

## Basic usage
Calculate and plot ESTELA maps for a location near Santander using the sample netcdf files.

NOTE: a longer period should to be considered to get meaningful results.

Using the command line interface:
```sh
# estela -h to check additional options
estela "./tests/sample_files/test20180101T??.nc" 44 -4 --outdir "."
```

Or python functions:
```python
from olas.estela import calc, plot
estelas = calc("./tests/sample_files/test20180101T??.nc", 44, -4)
plot(estelas, outdir=".")  # for plotting base maps
plot(estelas, gainloss=True, outdir=".")  # for plotting GL maps
```
