spharmgrid 0.1.0__tar.gz

spharmgrid-0.1.0/.gitignore

@@ -0,0 +1,215 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+# Keep the lockfile in version control for reproducible development and docs builds.
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

spharmgrid-0.1.0/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-26.04
+  tools:
+    python: "3.14"
+
+python:
+  install:
+    - method: uv
+      command: sync
+      groups:
+        - docs
+
+sphinx:
+  configuration: docs/conf.py

spharmgrid-0.1.0/.zenodo.json

@@ -0,0 +1,30 @@
+{
+  "title": "spharmgrid",
+  "description": "Spherical harmonic tools for filtering, regridding, and kinematics in atmospheric science with xarray.",
+  "creators": [
+    {
+      "name": "Yau, Albert M. W.",
+      "orcid": "0009-0000-7825-9627"
+    }
+  ],
+  "upload_type": "software",
+  "access_right": "open",
+  "license": "BSD-3-Clause",
+  "language": "eng",
+  "keywords": [
+    "spherical harmonics",
+    "atmospheric science",
+    "regridding",
+    "spectral filtering",
+    "atmospheric kinematics",
+    "xarray",
+    "Python"
+  ],
+  "related_identifiers": [
+    {
+      "identifier": "10.5281/zenodo.18764813",
+      "relation": "isDerivedFrom",
+      "resource_type": "software"
+    }
+  ]
+}

spharmgrid-0.1.0/CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+message: "If you use spharmgrid in research, please cite the software."
+title: spharmgrid
+type: software
+
+authors:
+  - family-names: Yau
+    given-names: Albert M. W.
+    orcid: "https://orcid.org/0009-0000-7825-9627"
+
+identifiers:
+  - type: doi
+    value: "10.5281/zenodo.22546616"
+    description: "Zenodo DOI for all versions of spharmgrid."
+
+repository-code: "https://github.com/mwyau/spharmgrid"
+url: "https://spharmgrid.readthedocs.io/"
+license: BSD-3-Clause
+
+keywords:
+  - spherical harmonics
+  - atmospheric science
+  - regridding
+  - spectral filtering
+  - atmospheric kinematics
+  - xarray
+  - Python

spharmgrid-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Albert Yau
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

spharmgrid-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.5
+Name: spharmgrid
+Version: 0.1.0
+Summary: Spherical harmonic tools for filtering, regridding, and kinematics in atmospheric science with xarray
+Project-URL: Documentation, https://spharmgrid.readthedocs.io/
+Project-URL: Repository, https://github.com/mwyau/spharmgrid
+Author: Albert Yau
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Requires-Python: >=3.12
+Requires-Dist: ducc0>=0.39.0
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: xarray>=2025.11.0
+Provides-Extra: cf
+Requires-Dist: cf-xarray>=0.10.4; extra == 'cf'
+Provides-Extra: cli
+Requires-Dist: cfgrib>=0.9.15; extra == 'cli'
+Requires-Dist: eccodeslib>=2.48.0.26; (sys_platform != 'win32') and extra == 'cli'
+Requires-Dist: h5netcdf[h5py]>=1.8.0; extra == 'cli'
+Requires-Dist: zarr>=3.0.0; extra == 'cli'
+Provides-Extra: dask
+Requires-Dist: dask[array]>=2024.1.0; extra == 'dask'
+Description-Content-Type: text/markdown
+
+# spharmgrid
+
+[![CI](https://github.com/mwyau/spharmgrid/actions/workflows/ci.yml/badge.svg)](https://github.com/mwyau/spharmgrid/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/spharmgrid/badge/?version=latest)](https://spharmgrid.readthedocs.io/en/latest/?badge=latest)
+[![PyPI version](https://img.shields.io/pypi/v/spharmgrid)](https://pypi.org/project/spharmgrid/)
+[![PyPI Python Version](https://img.shields.io/pypi/pyversions/spharmgrid)](https://pypi.org/project/spharmgrid/)
+[![GitHub License](https://img.shields.io/github/license/mwyau/spharmgrid)](https://github.com/mwyau/spharmgrid/blob/main/LICENSE)
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.22546616-blue.svg)](https://doi.org/10.5281/zenodo.22546616)
+
+Spherical harmonic tools for filtering, regridding, and kinematics in atmospheric science with xarray.
+
+**spharmgrid** (**sp**herical **harm**onic **grid**ding) implements spherical harmonic filtering, regridding, differential operators, and atmospheric kinematics for global xarray fields. It computes relative vorticity, divergence, streamfunction, velocity potential, Helmholtz decomposition, and inverse wind transforms. [DUCC](https://gitlab.mpcdf.mpg.de/mtr/ducc) performs the numerical spherical harmonic transforms.
+
+Supported grids are full rectangular Gauss–Legendre (GL) and pole-including Clenshaw–Curtis (CC) grids.
+
+## Install
+
+Install with either pip or uv:
+
+```bash
+pip install spharmgrid
+```
+
+```bash
+uv add spharmgrid
+```
+
+Optional groups are:
+
+- `spharmgrid[dask]` — Dask-backed lazy execution;
+- `spharmgrid[cf]` — optional cf-xarray coordinate discovery;
+- `spharmgrid[cli]` — command-line NetCDF, Zarr, and GRIB I/O.
+
+Dask-backed transforms execute lazily. DUCC uses four threads per transform. For the local Dask scheduler, spharmgrid sets `num_workers=max(1, os.cpu_count() // 4)` unless `num_workers` is configured.
+
+For a standalone command-line installation:
+
+```bash
+uv tool install "spharmgrid[cli]"
+```
+
+For a project environment, install the CLI extra with either:
+
+```bash
+uv add "spharmgrid[cli]"
+```
+
+```bash
+pip install "spharmgrid[cli]"
+```
+
+## Quick start
+
+Importing spharmgrid registers the `.sg` accessor on xarray objects. This example applies a T6–42 spectral filter to a `DataArray`:
+
+```python
+import xarray as xr
+import spharmgrid
+
+field = xr.open_dataarray("msl.nc")
+filtered = field.sg.filter("T6-42")
+```
+
+See the [Quick start](https://spharmgrid.readthedocs.io/en/latest/quickstart.html) for regridding, atmospheric wind diagnostics, direct-function equivalents, and further examples.
+
+## Documentation
+
+The optional CLI reads NetCDF, Zarr, and GRIB and writes NetCDF and Zarr. See the [CLI documentation](https://spharmgrid.readthedocs.io/en/latest/cli.html) for installation and usage.
+
+See the full [documentation](https://spharmgrid.readthedocs.io/) for grid requirements, coordinate handling, CF metadata, atmospheric kinematics, inverse transforms, zero-mode conventions, and command-line use.
+
+## References
+
+See the documentation [References](https://spharmgrid.readthedocs.io/en/latest/references.html) for the scientific literature and software cited by spharmgrid.
+
+## License
+
+spharmgrid is distributed under the [BSD 3-Clause License](LICENSE).

spharmgrid-0.1.0/README.md

@@ -0,0 +1,78 @@
+# spharmgrid
+
+[![CI](https://github.com/mwyau/spharmgrid/actions/workflows/ci.yml/badge.svg)](https://github.com/mwyau/spharmgrid/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/spharmgrid/badge/?version=latest)](https://spharmgrid.readthedocs.io/en/latest/?badge=latest)
+[![PyPI version](https://img.shields.io/pypi/v/spharmgrid)](https://pypi.org/project/spharmgrid/)
+[![PyPI Python Version](https://img.shields.io/pypi/pyversions/spharmgrid)](https://pypi.org/project/spharmgrid/)
+[![GitHub License](https://img.shields.io/github/license/mwyau/spharmgrid)](https://github.com/mwyau/spharmgrid/blob/main/LICENSE)
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.22546616-blue.svg)](https://doi.org/10.5281/zenodo.22546616)
+
+Spherical harmonic tools for filtering, regridding, and kinematics in atmospheric science with xarray.
+
+**spharmgrid** (**sp**herical **harm**onic **grid**ding) implements spherical harmonic filtering, regridding, differential operators, and atmospheric kinematics for global xarray fields. It computes relative vorticity, divergence, streamfunction, velocity potential, Helmholtz decomposition, and inverse wind transforms. [DUCC](https://gitlab.mpcdf.mpg.de/mtr/ducc) performs the numerical spherical harmonic transforms.
+
+Supported grids are full rectangular Gauss–Legendre (GL) and pole-including Clenshaw–Curtis (CC) grids.
+
+## Install
+
+Install with either pip or uv:
+
+```bash
+pip install spharmgrid
+```
+
+```bash
+uv add spharmgrid
+```
+
+Optional groups are:
+
+- `spharmgrid[dask]` — Dask-backed lazy execution;
+- `spharmgrid[cf]` — optional cf-xarray coordinate discovery;
+- `spharmgrid[cli]` — command-line NetCDF, Zarr, and GRIB I/O.
+
+Dask-backed transforms execute lazily. DUCC uses four threads per transform. For the local Dask scheduler, spharmgrid sets `num_workers=max(1, os.cpu_count() // 4)` unless `num_workers` is configured.
+
+For a standalone command-line installation:
+
+```bash
+uv tool install "spharmgrid[cli]"
+```
+
+For a project environment, install the CLI extra with either:
+
+```bash
+uv add "spharmgrid[cli]"
+```
+
+```bash
+pip install "spharmgrid[cli]"
+```
+
+## Quick start
+
+Importing spharmgrid registers the `.sg` accessor on xarray objects. This example applies a T6–42 spectral filter to a `DataArray`:
+
+```python
+import xarray as xr
+import spharmgrid
+
+field = xr.open_dataarray("msl.nc")
+filtered = field.sg.filter("T6-42")
+```
+
+See the [Quick start](https://spharmgrid.readthedocs.io/en/latest/quickstart.html) for regridding, atmospheric wind diagnostics, direct-function equivalents, and further examples.
+
+## Documentation
+
+The optional CLI reads NetCDF, Zarr, and GRIB and writes NetCDF and Zarr. See the [CLI documentation](https://spharmgrid.readthedocs.io/en/latest/cli.html) for installation and usage.
+
+See the full [documentation](https://spharmgrid.readthedocs.io/) for grid requirements, coordinate handling, CF metadata, atmospheric kinematics, inverse transforms, zero-mode conventions, and command-line use.
+
+## References
+
+See the documentation [References](https://spharmgrid.readthedocs.io/en/latest/references.html) for the scientific literature and software cited by spharmgrid.
+
+## License
+
+spharmgrid is distributed under the [BSD 3-Clause License](LICENSE).

spharmgrid-0.1.0/docs/_static/dark.css

@@ -0,0 +1,115 @@
+@media screen and (min-width: 1100px) {
+  .wy-nav-content {
+    max-width: 1200px;
+  }
+}
+
+@media (prefers-color-scheme: dark) {
+  html,
+  body,
+  .wy-body-for-nav,
+  .wy-nav-content-wrap,
+  .wy-nav-content {
+    background: #17191c;
+    color: #d7dce2;
+  }
+
+  .wy-nav-side {
+    background: #111316;
+  }
+
+  .wy-side-nav-search {
+    background: #20242a;
+  }
+
+  .wy-side-nav-search input[type="text"] {
+    background: #17191c;
+    border-color: #4a515b;
+    color: #f1f3f5;
+  }
+
+  .wy-menu-vertical a {
+    color: #c8ced6;
+  }
+
+  .wy-menu-vertical a:hover,
+  .wy-menu-vertical li.current > a,
+  .wy-menu-vertical li.on a {
+    background: #252a31;
+    color: #ffffff;
+  }
+
+  .wy-menu-vertical li.current,
+  .wy-menu-vertical li.toctree-l1.current > a {
+    background: #1d2126;
+  }
+
+  .rst-content h1,
+  .rst-content h2,
+  .rst-content h3,
+  .rst-content h4,
+  .rst-content h5,
+  .rst-content h6,
+  .rst-content p,
+  .rst-content li,
+  .rst-content dt,
+  .rst-content dd,
+  .rst-content table.docutils td,
+  .rst-content table.docutils th {
+    color: #d7dce2;
+  }
+
+  .rst-content a,
+  .wy-breadcrumbs a {
+    color: #75b7ff;
+  }
+
+  .rst-content code,
+  .rst-content tt,
+  code.literal {
+    background: #24282e;
+    border-color: #3a4048;
+    color: #f0f2f4;
+  }
+
+  .highlight,
+  .highlight pre,
+  div[class^="highlight"] {
+    background: #111316;
+    color: #e6e9ed;
+  }
+
+  .rst-content table.docutils,
+  .rst-content table.field-list,
+  .rst-content table.docutils td,
+  .rst-content table.docutils th {
+    border-color: #3a4048;
+  }
+
+  .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
+  .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) th {
+    background: #20242a;
+  }
+
+  .rst-content .admonition,
+  .rst-content .note,
+  .rst-content .warning,
+  .rst-content .seealso {
+    background: #20242a;
+  }
+
+  .rst-content blockquote {
+    border-color: #4a515b;
+    color: #c8ced6;
+  }
+
+  .wy-nav-top {
+    background: #20242a;
+  }
+
+  footer,
+  footer p,
+  footer a {
+    color: #9ea6b0;
+  }
+}