olas

Name	olas JSON
Version	0.2.0 JSON
	download
home_page	https://github.com/jorgeperezg/olas
Summary	Library with wave tools like ESTELA
upload_time	2023-03-20 01:03:38
maintainer
docs_url	None
author	jorge.perez
requires_python	>=3.8,<3.12
license	MIT
keywords	waves xarray estela
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>

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=".")
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jorgeperezg/olas",
    "name": "olas",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<3.12",
    "maintainer_email": "",
    "keywords": "waves,xarray,ESTELA",
    "author": "jorge.perez",
    "author_email": "j.perez@metocean.co.nz",
    "download_url": "https://files.pythonhosted.org/packages/49/93/dff28cc7e230a2ecc8a0bbb6d409f609b6b3908efceeacf31234327e6139/olas-0.2.0.tar.gz",
    "platform": null,
    "description": "# olas\n\n[![pypi package\nversion](https://img.shields.io/pypi/v/olas.svg)](https://pypi.python.org/pypi/olas)\n[![conda-forge\nversion](https://img.shields.io/conda/vn/conda-forge/olas.svg)](https://anaconda.org/conda-forge/olas)\n[![python supported\nshield](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\nThe documentation is generated with `poetry run portray on_github_pages`\n\n## Installation\n\nInstallation with conda is straightforward\n```\nconda install -c conda-forge olas\n```\n\nInstallation with pip requires cartopy (it can be installed with `conda install -c conda-forge cartopy`):\n```\npip install olas\n```\n\n## Basic usage\nCalculate and plot ESTELA maps from netcdf files.\n\n```\nfrom olas.estela import calc, plot\nestelas = calc(\"./tests/sample_files/test20180101T??.nc\", 44, -4, \"hs\", \"tp\", \"dp\")\nplot(estelas, outdir=\".\")\nplot(estelas, gainloss=True, outdir=\".\")\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Library with wave tools like ESTELA",
    "version": "0.2.0",
    "split_keywords": [
        "waves",
        "xarray",
        "estela"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "465acf6a211abec158ca960a0b6794ed2a032941229a17744fcae0303ceeed9c",
                "md5": "f3a4017b7cf5058f37068c5578c07ac3",
                "sha256": "e8f521cb2b69a8ca0eb68f66be0affc4c845addb58f1d3469fc0772f8df4604c"
            },
            "downloads": -1,
            "filename": "olas-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f3a4017b7cf5058f37068c5578c07ac3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<3.12",
            "size": 8516,
            "upload_time": "2023-03-20T01:03:36",
            "upload_time_iso_8601": "2023-03-20T01:03:36.032421Z",
            "url": "https://files.pythonhosted.org/packages/46/5a/cf6a211abec158ca960a0b6794ed2a032941229a17744fcae0303ceeed9c/olas-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4993dff28cc7e230a2ecc8a0bbb6d409f609b6b3908efceeacf31234327e6139",
                "md5": "fe9631b4d9d3ba01c5ec79e8f56954f7",
                "sha256": "0f6740f9adfd10cd51635b508eb626d3e35ec875aa93c2eb80376507b5c2bbae"
            },
            "downloads": -1,
            "filename": "olas-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fe9631b4d9d3ba01c5ec79e8f56954f7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<3.12",
            "size": 8199,
            "upload_time": "2023-03-20T01:03:38",
            "upload_time_iso_8601": "2023-03-20T01:03:38.638070Z",
            "url": "https://files.pythonhosted.org/packages/49/93/dff28cc7e230a2ecc8a0bbb6d409f609b6b3908efceeacf31234327e6139/olas-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-20 01:03:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "jorgeperezg",
    "github_project": "olas",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "olas"
}