olas

Name	olas JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	Library with wave tools like ESTELA
upload_time	2025-01-15 03:23:27
maintainer	None
docs_url	None
author	None
requires_python	<3.14,>=3.9
license	None
keywords	estela waves xarray
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 with pip (or similar tools) is straightforward:
```
pip install olas
```

It can also be installed with conda from conda-forge:
```
conda install -c conda-forge olas
```

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

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=".")
plot(estelas, outdir=".")  # gainloss=True for plotting GL maps
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "olas",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.9",
    "maintainer_email": null,
    "keywords": "ESTELA, waves, xarray",
    "author": null,
    "author_email": "Jorge Perez <j.perez@metocean.co.nz>",
    "download_url": "https://files.pythonhosted.org/packages/f3/ea/3b9ef1bc5f9b4a7d9f639b8f4642ae8583762d148548277539a7955e69da/olas-0.3.1.tar.gz",
    "platform": null,
    "description": "# olas\n\n[![pypi package version](https://img.shields.io/pypi/v/olas.svg)](https://pypi.python.org/pypi/olas)\n[![conda-forge version](https://img.shields.io/conda/vn/conda-forge/olas.svg)](https://anaconda.org/conda-forge/olas)\n[![python supported shield](https://img.shields.io/pypi/pyversions/olas.svg)](https://pypi.python.org/pypi/olas)\n\nLibrary with wave tools. At the moment it only includes a prototype of ESTELA.\n\nDocumentation: <https://jorgeperezg.github.io/olas>\n\n## Installation\n\nInstallation with pip (or similar tools) is straightforward:\n```\npip install olas\n```\n\nIt can also be installed with conda from conda-forge:\n```\nconda install -c conda-forge olas\n```\n\n## Basic usage\nCalculate and plot ESTELA maps from the sample netcdf files.\n\nUsing the command line interface:\n```sh\n# estela -h to check additional options\nestela \"./tests/sample_files/test20180101T??.nc\" 44 -4 --outdir \".\"\n```\n\nOr python functions:\n```python\nfrom olas.estela import calc, plot\nestelas = calc(\"./tests/sample_files/test20180101T??.nc\", 44, -4)\nplot(estelas, outdir=\".\")\nplot(estelas, outdir=\".\")  # gainloss=True for plotting GL maps\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Library with wave tools like ESTELA",
    "version": "0.3.1",
    "project_urls": {
        "documentation": "https://jorgeperezg.github.io/olas",
        "homepage": "https://github.com/jorgeperezg/olas",
        "repository": "https://github.com/jorgeperezg/olas"
    },
    "split_keywords": [
        "estela",
        " waves",
        " xarray"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "358af7dc9a22c0e958f083e03b0f525c53143cb208d64d17c09be2fe76efe040",
                "md5": "a9ddb80da7296fb723063569110bd4fa",
                "sha256": "0731c4a84d0e87bb6ab41b4cde0fdddcf86ea3186de0cd5c7df337cdaafa9a4d"
            },
            "downloads": -1,
            "filename": "olas-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a9ddb80da7296fb723063569110bd4fa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.9",
            "size": 9018,
            "upload_time": "2025-01-15T03:23:25",
            "upload_time_iso_8601": "2025-01-15T03:23:25.612583Z",
            "url": "https://files.pythonhosted.org/packages/35/8a/f7dc9a22c0e958f083e03b0f525c53143cb208d64d17c09be2fe76efe040/olas-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f3ea3b9ef1bc5f9b4a7d9f639b8f4642ae8583762d148548277539a7955e69da",
                "md5": "b8e500ad68264e17967111cdf60a5c85",
                "sha256": "f7cd2fa10ef2a09b6bd59309dceaca4f78a897af7fec5c9ea3b02d569d2ea126"
            },
            "downloads": -1,
            "filename": "olas-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b8e500ad68264e17967111cdf60a5c85",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.9",
            "size": 2685440,
            "upload_time": "2025-01-15T03:23:27",
            "upload_time_iso_8601": "2025-01-15T03:23:27.822998Z",
            "url": "https://files.pythonhosted.org/packages/f3/ea/3b9ef1bc5f9b4a7d9f639b8f4642ae8583762d148548277539a7955e69da/olas-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-15 03:23:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jorgeperezg",
    "github_project": "olas",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "olas"
}