Metadata-Version: 2.4
Name: pyshtransform
Version: 1.1.1
Summary: Spherical harmonics transformation in Python
Project-URL: Issues, https://github.com/aFarchi/pyshtransform/issues
Project-URL: Source, https://github.com/aFarchi/pyshtransform
Author-email: Alban Farchi <alban.farchi@ecmwf.int>
License-File: LICENSE
Keywords: spherical harmonics
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: xarray
Provides-Extra: dev
Requires-Dist: dask; extra == 'dev'
Requires-Dist: h5netcdf; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: rich; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: scipy-stubs; extra == 'dev'
Description-Content-Type: text/markdown

# pyshtransform

[![PyPI version](https://badge.fury.io/py/pyshtransform.svg)](https://badge.fury.io/py/pyshtransform)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Documentation status](https://app.readthedocs.org/projects/pyshtransform/badge/?version=latest)](https://app.readthedocs.org/projects/pyshtransform/badge/?version=latest)

`pyshtransform` is a python toolbox that implements spherical harmonics transformations.

- [Documentation](https://pyshtransform.readthedocs.io)
- [Source code](https://github.com/aFarchi/pyshtransform)
- [Issue tracker](https://github.com/aFarchi/pyshtransform/issues)

## Installation

Install using `pip`:

    $ pip install pyshtransform

## Usage

...

## Acknowledgements

This package contains some functions inspired by [SHTOOLS](https://shtools.github.io/SHTOOLS/).

## Todo-list

- write documentation

## Snippets

Code linting and formatting:
```sh
pixi run ruff check
pixi run ruff format
```

Static type checking:
```sh
pixi run mypy src/
```

Run test suite:
```sh
pixi run pytest -vs tests/
```

Generate api doc:
```sh
pixi run sphinx-apidoc -f -o docs/source/api/ src/
```

Generate doc:
```sh
pixi run sphinx-build -M clean docs/source/ docs/build/
pixi run sphinx-build -M html docs/source/ docs/build/
```

