canvod-readers 0.2.0__tar.gz

canvod_readers-0.2.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.3
+Name: canvod-readers
+Version: 0.2.0
+Summary: GNSS data format readers for canVODpy
+Keywords: GNSS,RINEX,GPS,geodesy,remote sensing
+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
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Dist: georinex>=1.16.0
+Requires-Dist: matplotlib>=3.7.0
+Requires-Dist: natsort>=8.4.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pint>=0.23
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: pytz>=2023.3
+Requires-Dist: xarray>=2023.12.0
+Requires-Dist: tomli>=2.0.0 ; python_full_version < '3.11'
+Requires-Dist: ipykernel>=7.1.0
+Requires-Dist: plotly>=6.5.1
+Requires-Dist: marimo>=0.19.7
+Requires-Dist: sbf-parser>=1.0.3
+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-readers
+
+GNSS data format readers for canVODpy.
+
+## Features
+
+- **RINEX v3.04 Support**: Complete reader for RINEX v3 observation files
+- **Signal IDs**: Unique identifiers for each GNSS signal (SV|BAND|CODE format)
+- **xarray Integration**: Convert observations to xarray Datasets
+- **Automatic Validation**: Header parsing and epoch completeness checking
+- **Memory Efficient**: Lazy iteration through large files
+- **Flexible Filtering**: Filter by GNSS system, frequency band, or code type
+
+## Installation
+
+```bash
+uv pip install canvod-readers
+```
+
+## Quick Start
+
+```python
+from pathlib import Path
+from canvod.readers import Rnxv3Obs
+
+# Load RINEX file
+filepath = Path("path/to/rinex.25o")
+reader = Rnxv3Obs(fpath=filepath)
+
+# Convert to xarray Dataset
+dataset = reader.to_ds(keep_rnx_data_vars=["SNR"])
+
+# Filter GPS L1 signals
+gps_l1 = dataset.where(
+    (dataset.system == 'G') & (dataset.band == 'L1'),
+    drop=True
+)
+```
+
+## Interactive Examples
+
+View interactive examples using marimo notebooks:
+
+```bash
+# Edit mode (interactive development)
+just marimo
+
+# Presentation mode (read-only)
+just marimo-present
+```
+
+Or directly:
+
+```bash
+uv run marimo edit docs/examples.py
+```
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/nfb2021/canvodpy.git
+cd canvodpy/packages/canvod-readers
+
+# Install dependencies
+uv sync
+
+# Run tests
+just test
+
+# Check code quality
+just check
+```
+
+## Documentation
+
+- Interactive examples: `docs/examples.py` (marimo notebook)
+- [Centralized documentation](../../docs/packages/readers/overview.md)
+
+## License
+
+Apache License 2.0

canvod_readers-0.2.0/README.md

@@ -0,0 +1,82 @@
+# canvod-readers
+
+GNSS data format readers for canVODpy.
+
+## Features
+
+- **RINEX v3.04 Support**: Complete reader for RINEX v3 observation files
+- **Signal IDs**: Unique identifiers for each GNSS signal (SV|BAND|CODE format)
+- **xarray Integration**: Convert observations to xarray Datasets
+- **Automatic Validation**: Header parsing and epoch completeness checking
+- **Memory Efficient**: Lazy iteration through large files
+- **Flexible Filtering**: Filter by GNSS system, frequency band, or code type
+
+## Installation
+
+```bash
+uv pip install canvod-readers
+```
+
+## Quick Start
+
+```python
+from pathlib import Path
+from canvod.readers import Rnxv3Obs
+
+# Load RINEX file
+filepath = Path("path/to/rinex.25o")
+reader = Rnxv3Obs(fpath=filepath)
+
+# Convert to xarray Dataset
+dataset = reader.to_ds(keep_rnx_data_vars=["SNR"])
+
+# Filter GPS L1 signals
+gps_l1 = dataset.where(
+    (dataset.system == 'G') & (dataset.band == 'L1'),
+    drop=True
+)
+```
+
+## Interactive Examples
+
+View interactive examples using marimo notebooks:
+
+```bash
+# Edit mode (interactive development)
+just marimo
+
+# Presentation mode (read-only)
+just marimo-present
+```
+
+Or directly:
+
+```bash
+uv run marimo edit docs/examples.py
+```
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/nfb2021/canvodpy.git
+cd canvodpy/packages/canvod-readers
+
+# Install dependencies
+uv sync
+
+# Run tests
+just test
+
+# Check code quality
+just check
+```
+
+## Documentation
+
+- Interactive examples: `docs/examples.py` (marimo notebook)
+- [Centralized documentation](../../docs/packages/readers/overview.md)
+
+## License
+
+Apache License 2.0

canvod_readers-0.2.0/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "canvod-readers"
+version = "0.2.0"
+description = "GNSS data format readers for canVODpy"
+readme = "README.md"
+requires-python = ">=3.14"
+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"},
+]
+keywords = ["GNSS", "RINEX", "GPS", "geodesy", "remote sensing"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: GIS",
+]
+dependencies = [
+    "georinex>=1.16.0",
+    "matplotlib>=3.7.0",
+    "natsort>=8.4.0",
+    "numpy>=1.24.0",
+    "pint>=0.23",
+    "pydantic>=2.5.0",
+    "pytz>=2023.3",
+    "xarray>=2023.12.0",
+    "tomli>=2.0.0; python_version < '3.11'",
+    "ipykernel>=7.1.0",
+    "plotly>=6.5.1",
+    "marimo>=0.19.7",
+    "sbf-parser>=1.0.3",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.14",
+    "ty>=0.0.9",
+    "marimo>=0.9.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.ty]
+extend-exclude = [
+    "**/docs/*.ipynb",
+    "**/docs/examples.py",
+]
+
+[tool.uv.build-backend]
+module-name = "canvod.readers"

canvod_readers-0.2.0/src/canvod/readers/__init__.py

@@ -0,0 +1,84 @@
+"""GNSS data format readers.
+
+This package provides readers for various GNSS data formats, all implementing
+a common interface for seamless integration with processing pipelines.
+
+Supported formats:
+- RINEX v3.04 (GNSS observations)
+- More formats coming soon...
+
+Quick Start
+-----------
+```python
+from canvod.readers import Rnxv3Obs
+
+# Read RINEX v3 file
+reader = Rnxv3Obs(fpath="station.24o")
+dataset = reader.to_ds()
+```
+
+Or use the canvodpy factory for automatic format detection:
+```python
+from canvodpy import ReaderFactory
+
+# Auto-detects format from file header
+reader = ReaderFactory.create_from_file("station.24o")
+dataset = reader.to_ds()
+```
+
+Directory Matching:
+```python
+from canvod.readers import DataDirMatcher
+
+# Find dates with RINEX files in both receivers
+matcher = DataDirMatcher(root=Path("/data/01_Rosalia"))
+for matched_dirs in matcher:
+    print(matched_dirs.yyyydoy)
+    # Load RINEX files from matched_dirs.canopy_data_dir
+```
+"""
+
+from canvod.readers.base import (
+    DEFAULT_REQUIRED_VARS,
+    REQUIRED_ATTRS,
+    REQUIRED_COORDS,
+    REQUIRED_DIMS,
+    DatasetStructureValidator,
+    GNSSDataReader,
+    SignalID,
+    validate_dataset,
+)
+from canvod.readers.builder import DatasetBuilder
+from canvod.readers.matching import (
+    DataDirMatcher,
+    MatchedDirs,
+    PairDataDirMatcher,
+    PairMatchedDirs,
+)
+from canvod.readers.rinex.v3_04 import Rnxv3Obs
+from canvod.readers.sbf import SbfEpoch, SbfHeader, SbfReader, SbfSignalObs
+from canvod.utils.tools import YYYYDOY
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "DEFAULT_REQUIRED_VARS",
+    "REQUIRED_ATTRS",
+    "REQUIRED_COORDS",
+    "REQUIRED_DIMS",
+    "YYYYDOY",
+    "DataDirMatcher",
+    "DatasetBuilder",
+    "DatasetStructureValidator",
+    "GNSSDataReader",
+    "MatchedDirs",
+    "PairDataDirMatcher",
+    "PairMatchedDirs",
+    "Rnxv3Obs",
+    "SbfEpoch",
+    "SbfHeader",
+    "SbfReader",
+    "SbfSignalObs",
+    "SignalID",
+    "validate_dataset",
+]