Skip to main content

A collection of tools for computing zonal mean and other related atmospheric circulation diagnostics

Project description

https://github.com/zdlawrence/pyzome/actions/workflows/ci_tests.yml/badge.svg https://codecov.io/github/zdlawrence/pyzome/branch/main/graph/badge.svg?token=J5CT0XW4FD Documentation Status

pyzome (rhymes with “rhizome”) is a Python package for atmospheric sciences. It simplifies the process of computing relevant diagnostics commonly used to understand the general atmospheric circulation of the Earth and other planetary atmospheres. It is designed to be used in conjunction with xarray for enabling coordinate- and unit-aware computations.

pyzome is in an early stage and currently under active development. While much of the core functionality is in place, the API (e.g., function names and call signatures) is still subject to change.

Install

pyzome is available on PyPI and can be installed with pip:

pip install pyzome

Features

  • zonal and meridional mean computations

  • zonal wavenumber decompositions of fields; zonal wave covariances between 2 fields

  • Transformed Eulerian Mean (TEM) diagnostics, such as EP-fluxes and residual velocities

  • quasi-geostrophic diagnostics, such as meridional QGPV gradients and the refractive index

  • A “recipes” framework that simplifies the process of computing these diagnostics

  • More to come!

Development Roadmap

  • Build on cf-xarray to streamline coordinate-aware computations

  • Build on pint and pint-xarray to streamline unit-aware computations

  • Expand documentation

  • Diagnostics validation

  • Add more core modules:
    • Equivalent Latitude computations

    • ???

  • Expand “recipes” to include more diagnostics
    • Annular mode indices

    • Sudden stratospheric warmings

    • Momentum budgets

    • ???

Acknowledgments

The development of this code was originally supported by the NWS OSTI Weeks 3-4 Program under NOAA Award NA20NWS4680051. Continued support and development of the package is provided on a volunteer basis by the author and contributors.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyzome-2023.9.0.tar.gz (39.3 kB view hashes)

Uploaded Source

Built Distribution

pyzome-2023.9.0-py3-none-any.whl (26.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page