canvod-auxiliary 0.2.0__tar.gz

canvod_auxiliary-0.2.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.3
+Name: canvod-auxiliary
+Version: 0.2.0
+Summary: Auxiliary data augmentation for GNSS VOD analysis
+Keywords: GNSS,VOD,auxiliary,SP3,CLK,ephemeris,clock
+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: canvod-readers>=0.1.0
+Requires-Dist: scipy>=1.15.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: xarray>=2023.12.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: retrying>=1.3.4
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: lxml>=5.3.0
+Requires-Dist: pint>=0.23
+Requires-Dist: pymap3d>=3.0.0
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: hvplot>=0.12.2
+Requires-Dist: plotly>=6.5.1
+Requires-Dist: mcp>=1.25.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
+Description-Content-Type: text/markdown
+
+# canvod-auxiliary
+
+**Auxiliary data augmentation for GNSS VOD analysis**
+
+Part of the [canVODpy](https://github.com/nfb2021/canvodpy) ecosystem.
+
+## Overview
+
+`canvod-auxiliary` provides tools for downloading, parsing, and interpolating auxiliary GNSS data files including:
+
+- **SP3 ephemerides** - Satellite orbit positions and velocities
+- **CLK corrections** - Satellite clock corrections
+- **Interpolation strategies** - Hermite and linear interpolation for temporal alignment
+- **Augmentation framework** - Pluggable system for enriching RINEX datasets
+
+## Features
+
+**SP3 File Handling**
+- Download from ESA or NASA CDDIS servers
+- Parse SP3 format (positions + velocities)
+- Cubic Hermite interpolation using velocities
+- Fallback to linear interpolation
+
+**Clock Corrections**
+- CLK file download and parsing
+- Jump-aware interpolation
+- Segment-based processing
+
+**Flexible Pipeline**
+- Automatic file discovery and caching
+- Thread-safe downloading
+- Configurable FTP servers and agencies
+
+**Augmentation System**
+- Spherical coordinate calculation (φ, θ, r)
+- Clock correction application
+- Extensible via ABC pattern
+
+## Installation
+
+```bash
+# From PyPI (when published)
+pip install canvod-auxiliary
+
+# Development install
+cd canvodpy/packages/canvod-auxiliary
+uv pip install -e .
+```
+
+## Quick Start
+
+### Basic SP3 Usage
+
+```python
+from pathlib import Path
+from canvod.auxiliary import Sp3File
+
+# Load SP3 ephemeris file
+sp3 = Sp3File.from_file(Path("COD0MGXFIN_20240150000_01D_05M_ORB.SP3"))
+
+# Access data as xarray Dataset
+data = sp3.data
+print(data)  # Coordinates: epoch, sid | Variables: X, Y, Z, Vx, Vy, Vz
+
+# Get interpolation strategy
+strategy = sp3.get_interpolation_strategy()
+print(strategy.config)  # Sp3Config(use_velocities=True)
+```
+
+### Pipeline Usage
+
+```python
+from canvod.auxiliary import AuxDataPipeline
+from pathlib import Path
+
+# Create pipeline
+pipeline = AuxDataPipeline(
+    agency="COD",
+    product_type="final",
+    ftp_server="ftp://gssc.esa.int/gnss",
+    aux_file_path=Path("aux_data")
+)
+
+# Get augmented data for specific date
+augmented_ds = pipeline.get_or_create_aux_data(
+    yyyydoy="2024015",
+    target_epochs=my_rinex_epochs
+)
+```
+
+### Custom Interpolation
+
+```python
+from canvod.auxiliary import Sp3Config, Sp3InterpolationStrategy
+import numpy as np
+
+# Configure interpolation
+config = Sp3Config(use_velocities=True, fallback_method='cubic')
+strategy = Sp3InterpolationStrategy(config=config)
+
+# Interpolate to new epochs
+target_epochs = np.array([...])  # Your target timestamps
+interpolated = strategy.interpolate(sp3_dataset, target_epochs)
+```
+
+## Documentation
+
+[Centralized documentation](../../docs/packages/auxiliary/overview.md)
+
+## Package Structure
+
+```
+canvod-auxiliary/
+├── src/canvod/aux/
+│   ├── __init__.py              # Public API
+│   ├── _internal/               # Internal utilities
+│   │   ├── units.py             # UREG unit registry
+│   │   ├── date_utils.py        # YYYYDOY, GPS week utils
+│   │   └── logger.py            # Logging utilities
+│   ├── reader.py                # AuxFile ABC
+│   ├── container.py             # FTP downloader
+│   ├── interpolation.py         # Interpolation strategies
+│   ├── sp3.py                   # SP3 handler
+│   ├── clk.py                   # CLK handler
+│   ├── pipeline.py              # AuxDataPipeline
+│   └── augmentation.py          # Augmentation framework
+├── tests/                       # 65 tests, 100% core coverage
+├── docs/                        # MyST documentation
+└── pyproject.toml
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone repository
+git clone https://github.com/nfb2021/canvodpy.git
+cd canvodpy/packages/canvod-auxiliary
+
+# Install dependencies
+uv sync
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Commands
+
+```bash
+# Run tests
+pytest
+
+# With coverage
+pytest --cov=canvod.auxiliary --cov-report=html
+
+# Lint and format
+ruff check .
+ruff format .
+
+# Type check
+ty check src/
+```
+
+### Project Tasks (Just)
+
+If you have [Just](https://github.com/casey/just) installed:
+
+```bash
+just test          # Run tests
+just check         # Lint + format check
+just fix           # Auto-fix linting issues
+just docs          # Build documentation
+```
+
+## Dependencies
+
+**Core:**
+- scipy ≥1.15.0
+- numpy ≥1.24.0
+- xarray ≥2023.12.0
+- pydantic ≥2.5.0
+- pint ≥0.23
+
+**Network:**
+- requests ≥2.31.0
+
+- retrying ≥1.3.4
+- beautifulsoup4 ≥4.12.0
+- lxml ≥5.3.0
+
+**Development:**
+- pytest ≥8.0
+- pytest-cov ≥5.0
+- ruff ≥0.14
+- ty ≥0.0.9
+
+## Contributing
+
+Contributions welcome! Please see the [main repository](https://github.com/nfb2021/canvodpy) for contribution guidelines.
+
+## License
+
+Apache License 2.0 - See LICENSE file
+
+## Related Packages
+
+Part of the canVODpy ecosystem:
+
+- **[canvod-readers](../canvod-readers/)** - RINEX data readers
+- **[canvod-grids](../canvod-grids/)** - Hemisphere grids
+- **[canvod-vod](../canvod-vod/)** - VOD calculations
+- **[canvod-store](../canvod-store/)** - Icechunk storage
+- **[canvod-viz](../canvod-viz/)** - Visualization
+- **[canvodpy](../../canvodpy/)** - Umbrella package
+
+## Citation
+
+If you use canvod-auxiliary in your research, please cite:
+
+```bibtex
+@software{canvodpy2026,
+  author = {Bader, Nicolas F.},
+  title = {canVODpy: GNSS Transmissometry Analysis},
+  year = {2026},
+  publisher = {TU Wien},
+  url = {https://github.com/nfb2021/canvodpy}
+}
+```
+
+## Author & Affiliation
+
+**Nicolas François Bader**
+Climate and Environmental Remote Sensing Research Unit (CLIMERS)
+Department of Geodesy and Geoinformation
+TU Wien (Vienna University of Technology)
+Email: nicolas.bader@geo.tuwien.ac.at
+[https://www.tuwien.at/en/mg/geo/climers](https://www.tuwien.at/en/mg/geo/climers)

canvod_auxiliary-0.2.0/README.md

@@ -0,0 +1,238 @@
+# canvod-auxiliary
+
+**Auxiliary data augmentation for GNSS VOD analysis**
+
+Part of the [canVODpy](https://github.com/nfb2021/canvodpy) ecosystem.
+
+## Overview
+
+`canvod-auxiliary` provides tools for downloading, parsing, and interpolating auxiliary GNSS data files including:
+
+- **SP3 ephemerides** - Satellite orbit positions and velocities
+- **CLK corrections** - Satellite clock corrections
+- **Interpolation strategies** - Hermite and linear interpolation for temporal alignment
+- **Augmentation framework** - Pluggable system for enriching RINEX datasets
+
+## Features
+
+**SP3 File Handling**
+- Download from ESA or NASA CDDIS servers
+- Parse SP3 format (positions + velocities)
+- Cubic Hermite interpolation using velocities
+- Fallback to linear interpolation
+
+**Clock Corrections**
+- CLK file download and parsing
+- Jump-aware interpolation
+- Segment-based processing
+
+**Flexible Pipeline**
+- Automatic file discovery and caching
+- Thread-safe downloading
+- Configurable FTP servers and agencies
+
+**Augmentation System**
+- Spherical coordinate calculation (φ, θ, r)
+- Clock correction application
+- Extensible via ABC pattern
+
+## Installation
+
+```bash
+# From PyPI (when published)
+pip install canvod-auxiliary
+
+# Development install
+cd canvodpy/packages/canvod-auxiliary
+uv pip install -e .
+```
+
+## Quick Start
+
+### Basic SP3 Usage
+
+```python
+from pathlib import Path
+from canvod.auxiliary import Sp3File
+
+# Load SP3 ephemeris file
+sp3 = Sp3File.from_file(Path("COD0MGXFIN_20240150000_01D_05M_ORB.SP3"))
+
+# Access data as xarray Dataset
+data = sp3.data
+print(data)  # Coordinates: epoch, sid | Variables: X, Y, Z, Vx, Vy, Vz
+
+# Get interpolation strategy
+strategy = sp3.get_interpolation_strategy()
+print(strategy.config)  # Sp3Config(use_velocities=True)
+```
+
+### Pipeline Usage
+
+```python
+from canvod.auxiliary import AuxDataPipeline
+from pathlib import Path
+
+# Create pipeline
+pipeline = AuxDataPipeline(
+    agency="COD",
+    product_type="final",
+    ftp_server="ftp://gssc.esa.int/gnss",
+    aux_file_path=Path("aux_data")
+)
+
+# Get augmented data for specific date
+augmented_ds = pipeline.get_or_create_aux_data(
+    yyyydoy="2024015",
+    target_epochs=my_rinex_epochs
+)
+```
+
+### Custom Interpolation
+
+```python
+from canvod.auxiliary import Sp3Config, Sp3InterpolationStrategy
+import numpy as np
+
+# Configure interpolation
+config = Sp3Config(use_velocities=True, fallback_method='cubic')
+strategy = Sp3InterpolationStrategy(config=config)
+
+# Interpolate to new epochs
+target_epochs = np.array([...])  # Your target timestamps
+interpolated = strategy.interpolate(sp3_dataset, target_epochs)
+```
+
+## Documentation
+
+[Centralized documentation](../../docs/packages/auxiliary/overview.md)
+
+## Package Structure
+
+```
+canvod-auxiliary/
+├── src/canvod/aux/
+│   ├── __init__.py              # Public API
+│   ├── _internal/               # Internal utilities
+│   │   ├── units.py             # UREG unit registry
+│   │   ├── date_utils.py        # YYYYDOY, GPS week utils
+│   │   └── logger.py            # Logging utilities
+│   ├── reader.py                # AuxFile ABC
+│   ├── container.py             # FTP downloader
+│   ├── interpolation.py         # Interpolation strategies
+│   ├── sp3.py                   # SP3 handler
+│   ├── clk.py                   # CLK handler
+│   ├── pipeline.py              # AuxDataPipeline
+│   └── augmentation.py          # Augmentation framework
+├── tests/                       # 65 tests, 100% core coverage
+├── docs/                        # MyST documentation
+└── pyproject.toml
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone repository
+git clone https://github.com/nfb2021/canvodpy.git
+cd canvodpy/packages/canvod-auxiliary
+
+# Install dependencies
+uv sync
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Commands
+
+```bash
+# Run tests
+pytest
+
+# With coverage
+pytest --cov=canvod.auxiliary --cov-report=html
+
+# Lint and format
+ruff check .
+ruff format .
+
+# Type check
+ty check src/
+```
+
+### Project Tasks (Just)
+
+If you have [Just](https://github.com/casey/just) installed:
+
+```bash
+just test          # Run tests
+just check         # Lint + format check
+just fix           # Auto-fix linting issues
+just docs          # Build documentation
+```
+
+## Dependencies
+
+**Core:**
+- scipy ≥1.15.0
+- numpy ≥1.24.0
+- xarray ≥2023.12.0
+- pydantic ≥2.5.0
+- pint ≥0.23
+
+**Network:**
+- requests ≥2.31.0
+
+- retrying ≥1.3.4
+- beautifulsoup4 ≥4.12.0
+- lxml ≥5.3.0
+
+**Development:**
+- pytest ≥8.0
+- pytest-cov ≥5.0
+- ruff ≥0.14
+- ty ≥0.0.9
+
+## Contributing
+
+Contributions welcome! Please see the [main repository](https://github.com/nfb2021/canvodpy) for contribution guidelines.
+
+## License
+
+Apache License 2.0 - See LICENSE file
+
+## Related Packages
+
+Part of the canVODpy ecosystem:
+
+- **[canvod-readers](../canvod-readers/)** - RINEX data readers
+- **[canvod-grids](../canvod-grids/)** - Hemisphere grids
+- **[canvod-vod](../canvod-vod/)** - VOD calculations
+- **[canvod-store](../canvod-store/)** - Icechunk storage
+- **[canvod-viz](../canvod-viz/)** - Visualization
+- **[canvodpy](../../canvodpy/)** - Umbrella package
+
+## Citation
+
+If you use canvod-auxiliary in your research, please cite:
+
+```bibtex
+@software{canvodpy2026,
+  author = {Bader, Nicolas F.},
+  title = {canVODpy: GNSS Transmissometry Analysis},
+  year = {2026},
+  publisher = {TU Wien},
+  url = {https://github.com/nfb2021/canvodpy}
+}
+```
+
+## Author & Affiliation
+
+**Nicolas François Bader**
+Climate and Environmental Remote Sensing Research Unit (CLIMERS)
+Department of Geodesy and Geoinformation
+TU Wien (Vienna University of Technology)
+Email: nicolas.bader@geo.tuwien.ac.at
+[https://www.tuwien.at/en/mg/geo/climers](https://www.tuwien.at/en/mg/geo/climers)

canvod_auxiliary-0.2.0/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "canvod-auxiliary"
+version = "0.2.0"
+description = "Auxiliary data augmentation for GNSS VOD analysis"
+authors = [
+    {name = "Nicolas François Bader", email = "nicolas.bader@geo.tuwien.ac.at"}
+]
+maintainers = [
+    {name = "Climate and Environmental Remote Sensing (CLIMERS)", email = "nicolas.bader@geo.tuwien.ac.at"}
+]
+readme = "README.md"
+requires-python = ">=3.14"
+keywords = ["GNSS", "VOD", "auxiliary", "SP3", "CLK", "ephemeris", "clock"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+]
+
+dependencies = [
+    "canvod-readers>=0.1.0",
+    "scipy>=1.15.0",
+    "numpy>=1.24.0",
+    "xarray>=2023.12.0",
+    "pydantic>=2.5.0",
+    "requests>=2.31.0",
+
+    "retrying>=1.3.4",
+    "beautifulsoup4>=4.12.0",
+    "lxml>=5.3.0",
+    "pint>=0.23",
+    "pymap3d>=3.0.0",
+    "tqdm>=4.67.1",
+    "hvplot>=0.12.2",
+    "plotly>=6.5.1",
+    "mcp>=1.25.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.14",
+    "ty>=0.0.9",
+    "marimo>=0.9.0",
+    "matplotlib>=3.8.0",
+    "polars>=1.0.0",
+]
+
+[tool.uv.sources]
+canvod-readers = { workspace = true }
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "canvod.auxiliary"
+
+[tool.ruff]
+line-length = 88
+target-version = "py314"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]
+ignore = []
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+    "-v",
+    "--strict-markers",
+    "--tb=short",
+    "--disable-warnings",
+]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "integration: marks tests as integration tests",
+    "network: marks tests that require network access",
+]