Metadata-Version: 2.3
Name: canvod-vod
Version: 0.2.2
Summary: Vegetation Optical Depth retrieval algorithms for GNSS-Transmissometry
Keywords: GNSS,VOD,vegetation,tau-omega
Author: Nicolas François Bader
Author-email: Nicolas François Bader <nicolas.bader@geo.tuwien.ac.at>
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: numpy>=1.24.0
Requires-Dist: xarray>=2023.12.0
Requires-Dist: pydantic>=2.0.0
Maintainer: Climate and Environmental Remote Sensing (CLIMERS)
Maintainer-email: Climate and Environmental Remote Sensing (CLIMERS) <nicolas.bader@geo.tuwien.ac.at>
Requires-Python: >=3.14
Project-URL: Homepage, https://github.com/nfb2021/canvodpy
Project-URL: Documentation, https://nfb2021.github.io/canvodpy/packages/vod/overview/
Project-URL: Repository, https://github.com/nfb2021/canvodpy
Project-URL: Issues, https://github.com/nfb2021/canvodpy/issues
Description-Content-Type: text/markdown

# canvod-vod

VOD calculation for GNSS vegetation analysis.

Part of the [canVODpy](https://github.com/nfb2021/canvodpy) ecosystem.

## Overview

This package provides VOD (Vegetation Optical Depth) calculation algorithms based on the Tau-Omega model:
- Zeroth-order approximation (TauOmegaZerothOrder)
- Abstract base class for custom implementations

## Installation

```bash
uv pip install canvod-vod
```

## Quick Start

```python
from canvod.vod import TauOmegaZerothOrder
import xarray as xr

# Load canopy and sky datasets
canopy_ds = xr.open_dataset("canopy.nc")
sky_ds = xr.open_dataset("sky.nc")

# Calculate VOD
vod_ds = TauOmegaZerothOrder.from_datasets(
    canopy_ds=canopy_ds,
    sky_ds=sky_ds,
    align=True
)
```

## Features

- Abstract base class for VOD calculators
- Pydantic validation for input datasets
- Support for both direct dataset and Icechunk store inputs
- Zeroth-order Tau-Omega approximation

## Documentation

[Full documentation](https://nfb2021.github.io/canvodpy/packages/vod/overview/)


## License

Apache License 2.0 - see LICENSE file
