canvod-config 1.0.0__tar.gz

canvod_config-1.0.0/LICENSE

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Nicolas François Bader
+   Climate and Environmental Remote Sensing Research Unit (CLIMERS)
+   Department of Geodesy and Geoinformation, TU Wien
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

canvod_config-1.0.0/NOTICE

@@ -0,0 +1,11 @@
+canVODpy
+Copyright 2026 Nicolas François Bader, TU Wien
+
+This product includes software developed at the
+Climate and Environmental Remote Sensing Research Unit (CLIMERS),
+Department of Geodesy and Geoinformation, TU Wien.
+
+This product includes contributions from the canVODpy community.
+Individual contributors are listed in the CONTRIBUTORS.md file and
+recorded in the Git revision history of the repository:
+https://github.com/TUW-GEO/canvodpy

canvod_config-1.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: canvod-config
+Version: 1.0.0
+Summary: The canVODpy settings file: models, loading, and checks
+Keywords: GNSS,VOD,configuration,settings,YAML,pydantic,remote sensing
+Author: Nicolas François Bader
+Author-email: Nicolas François Bader <support@canvodpy.eu>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: email-validator>=2.0
+Requires-Dist: psutil>=7.2.2
+Requires-Dist: canvod-utils>=1.0.0,<2
+Maintainer: Climate and Environmental Remote Sensing (CLIMERS)
+Maintainer-email: Climate and Environmental Remote Sensing (CLIMERS) <support@canvodpy.eu>
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/TUW-GEO/canvodpy
+Project-URL: Documentation, https://canvodpy.eu/packages/config/overview/
+Project-URL: Repository, https://github.com/TUW-GEO/canvodpy
+Project-URL: Issues, https://github.com/TUW-GEO/canvodpy/issues
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/TUW-GEO/canvodpy/main/docs/assets/logo/canvodpy_logo_dark_mode.svg">
+    <img alt="canVODpy" src="https://raw.githubusercontent.com/TUW-GEO/canvodpy/main/docs/assets/logo/canvodpy_logo_bright_mode.svg" width="260">
+  </picture>
+</p>
+
+# canvod-config
+
+[![PyPI](https://img.shields.io/pypi/v/canvod-config.svg)](https://pypi.org/project/canvod-config/)
+[![Python](https://img.shields.io/badge/python-3.14-blue.svg)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/TUW-GEO/canvodpy/blob/main/LICENSE)
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.18496233-blue)](https://doi.org/10.5281/zenodo.18496233)
+
+**The canVODpy settings file: models, loading, and checks.** `canvod-config` is a package of
+[canVODpy](https://canvodpy.eu/), an open Python ecosystem for
+GNSS-Transmissometry canopy VOD retrievals.
+
+## What it does
+
+- Reads `canvod-settings.yaml` and checks it with Pydantic models.
+- Gives every other canVODpy package its settings.
+- `canvodpy config init`, `validate` and `explain` on the command line use it.
+
+## Install
+
+```bash
+uv add canvod-config
+```
+
+Most users install [canvodpy](https://pypi.org/project/canvodpy/), which
+includes this package, the command line, and the processing pipeline.
+canVODpy requires Python 3.14.
+
+## Example
+
+```python
+from canvod.config import load_config
+
+config = load_config()  # finds canvod-settings.yaml as the command line does
+print(config.processing.storage.stores_root_dir)
+```
+
+## Documentation
+
+- [canvod-config in the canVODpy documentation](https://canvodpy.eu/packages/config/overview/)
+- [Start here](https://canvodpy.eu/users/): from installation to the first VOD
+
+## How to cite
+
+If you use canVODpy, please cite it with its DOI,
+[`10.5281/zenodo.18496233`](https://doi.org/10.5281/zenodo.18496233), which always leads to the newest
+version. [CITATION.cff](https://github.com/TUW-GEO/canvodpy/blob/main/CITATION.cff) has the full
+citation.
+
+## License
+
+[Apache License 2.0](https://github.com/TUW-GEO/canvodpy/blob/main/LICENSE)

canvod_config-1.0.0/README.md

@@ -0,0 +1,58 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/TUW-GEO/canvodpy/main/docs/assets/logo/canvodpy_logo_dark_mode.svg">
+    <img alt="canVODpy" src="https://raw.githubusercontent.com/TUW-GEO/canvodpy/main/docs/assets/logo/canvodpy_logo_bright_mode.svg" width="260">
+  </picture>
+</p>
+
+# canvod-config
+
+[![PyPI](https://img.shields.io/pypi/v/canvod-config.svg)](https://pypi.org/project/canvod-config/)
+[![Python](https://img.shields.io/badge/python-3.14-blue.svg)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/TUW-GEO/canvodpy/blob/main/LICENSE)
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.18496233-blue)](https://doi.org/10.5281/zenodo.18496233)
+
+**The canVODpy settings file: models, loading, and checks.** `canvod-config` is a package of
+[canVODpy](https://canvodpy.eu/), an open Python ecosystem for
+GNSS-Transmissometry canopy VOD retrievals.
+
+## What it does
+
+- Reads `canvod-settings.yaml` and checks it with Pydantic models.
+- Gives every other canVODpy package its settings.
+- `canvodpy config init`, `validate` and `explain` on the command line use it.
+
+## Install
+
+```bash
+uv add canvod-config
+```
+
+Most users install [canvodpy](https://pypi.org/project/canvodpy/), which
+includes this package, the command line, and the processing pipeline.
+canVODpy requires Python 3.14.
+
+## Example
+
+```python
+from canvod.config import load_config
+
+config = load_config()  # finds canvod-settings.yaml as the command line does
+print(config.processing.storage.stores_root_dir)
+```
+
+## Documentation
+
+- [canvod-config in the canVODpy documentation](https://canvodpy.eu/packages/config/overview/)
+- [Start here](https://canvodpy.eu/users/): from installation to the first VOD
+
+## How to cite
+
+If you use canVODpy, please cite it with its DOI,
+[`10.5281/zenodo.18496233`](https://doi.org/10.5281/zenodo.18496233), which always leads to the newest
+version. [CITATION.cff](https://github.com/TUW-GEO/canvodpy/blob/main/CITATION.cff) has the full
+citation.
+
+## License
+
+[Apache License 2.0](https://github.com/TUW-GEO/canvodpy/blob/main/LICENSE)

canvod_config-1.0.0/pyproject.toml

@@ -0,0 +1,61 @@
+[project]
+name = "canvod-config"
+version = "1.0.0"
+description = "The canVODpy settings file: models, loading, and checks"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "Apache-2.0"
+license-files = [
+    "LICENSE",
+    "NOTICE",
+]
+keywords = [
+    "GNSS",
+    "VOD",
+    "configuration",
+    "settings",
+    "YAML",
+    "pydantic",
+    "remote sensing",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "pydantic>=2.0",
+    "pydantic-settings>=2.0",
+    "pyyaml>=6.0",
+    "email-validator>=2.0",
+    "psutil>=7.2.2",
+    "canvod-utils>=1.0.0,<2",
+]
+
+[[project.authors]]
+name = "Nicolas François Bader"
+email = "support@canvodpy.eu"
+
+[[project.maintainers]]
+name = "Climate and Environmental Remote Sensing (CLIMERS)"
+email = "support@canvodpy.eu"
+
+[project.urls]
+Homepage = "https://github.com/TUW-GEO/canvodpy"
+Documentation = "https://canvodpy.eu/packages/config/overview/"
+Repository = "https://github.com/TUW-GEO/canvodpy"
+Issues = "https://github.com/TUW-GEO/canvodpy/issues"
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.sources.canvod-utils]
+workspace = true
+
+[tool.uv.build-backend]
+module-name = "canvod.config"

canvod_config-1.0.0/pyproject.toml.orig

@@ -0,0 +1,57 @@
+[project]
+name = "canvod-config"
+version = "1.0.0"
+description = "The canVODpy settings file: models, loading, and checks"
+readme = "README.md"
+requires-python = ">=3.14"
+authors = [
+    {name = "Nicolas François Bader", email = "support@canvodpy.eu"},
+]
+maintainers = [
+    {name = "Climate and Environmental Remote Sensing (CLIMERS)", email = "support@canvodpy.eu"},
+]
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+keywords = [
+    "GNSS",
+    "VOD",
+    "configuration",
+    "settings",
+    "YAML",
+    "pydantic",
+    "remote sensing",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering",
+]
+
+dependencies = [
+    "pydantic>=2.0",
+    "pydantic-settings>=2.0",
+    "pyyaml>=6.0",
+    "email-validator>=2.0",
+    "psutil>=7.2.2",
+    "canvod-utils>=1.0.0,<2",
+]
+
+[project.urls]
+Homepage = "https://github.com/TUW-GEO/canvodpy"
+Documentation = "https://canvodpy.eu/packages/config/overview/"
+Repository = "https://github.com/TUW-GEO/canvodpy"
+Issues = "https://github.com/TUW-GEO/canvodpy/issues"
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.sources]
+canvod-utils = { workspace = true }
+
+[tool.uv.build-backend]
+module-name = "canvod.config"

canvod_config-1.0.0/src/canvod/config/__init__.py

@@ -0,0 +1,36 @@
+"""
+Configuration management for canvodpy.
+
+This package provides:
+- Pydantic models for type-safe configuration
+- YAML-based configuration loading
+- CLI for configuration management
+- Validation and error reporting
+
+Examples
+--------
+>>> from canvod.config import load_config
+>>> config = load_config()
+>>> print(config.nasa_earthdata_acc_mail)
+>>> print(config.processing.aux_data.agency)
+"""
+
+from .loader import load_config
+from .models import (
+    CanvodConfig,
+    MetadataConfig,
+    ProcessingConfig,
+    SidsConfig,
+    SiteConfig,
+    SitesConfig,
+)
+
+__all__ = [
+    "CanvodConfig",
+    "MetadataConfig",
+    "ProcessingConfig",
+    "SidsConfig",
+    "SiteConfig",
+    "SitesConfig",
+    "load_config",
+]

canvod_config-1.0.0/src/canvod/config/defaults/processing.yaml

@@ -0,0 +1,66 @@
+# ============================================================================
+# Default Processing Configuration
+# ============================================================================
+# These are package defaults. The processing: section of the user's
+# config/canvod-settings.yaml (created by: just config-init) overrides them.
+
+metadata:
+  author: Unknown
+  email: user@example.com
+  institution: Unknown Institution
+
+credentials:
+  nasa_earthdata_acc_mail: null  # Prefer: set CANVOD__PROCESSING__CREDENTIALS__NASA_EARTHDATA_ACC_MAIL in config/.env
+
+aux_data:
+  agency: COD
+  product_type: final
+
+params:
+  keep_gnss_observables:
+    - SNR
+  rinex_v3_parser: validated  # 'unvalidated_fast' is DANGEROUS: no checks, results are the user's responsibility
+  aggregate_glonass_fdma: true
+  store_radial_distance: false
+  store_delta_snr: false
+  store_radial_diff: false
+  receiver_position_mode: shared
+  ephemeris_source: final  # 'final' (SP3/CLK) or 'broadcast' (SBF SatVisibility)
+  resource_mode: auto
+  # n_max_threads, cpu_affinity, nice_priority
+  # are only used when resource_mode: manual
+
+netcdf_compression:
+  zlib: true
+  complevel: 5
+
+icechunk:
+  compression_level: 3
+  compression_algorithm: zstd
+  inline_chunk_threshold_bytes: 512
+  get_partial_values_concurrency: 1
+  # max_concurrent_requests: null   # icechunk default
+  # cache_num_chunk_refs: null      # icechunk default
+  # cache_num_bytes_chunks: null    # icechunk default
+  chunk_strategies:
+    gnss_store:
+      epoch: 180  # one 15-min file at 5 s sampling; set to the epochs per file
+      sid: -1
+    vod_store:
+      epoch: 180  # as gnss_store, so every cadence of a GNSS day fits
+      sid: -1
+  manifest_preload_enabled: false
+  manifest_preload_max_refs: 10000
+  manifest_preload_max_arrays_to_scan: 500
+  manifest_preload_pattern: "^(epoch|sid)$"
+  manifest_splitting_enabled: true
+  manifest_splitting_epoch_range: 17280  # epoch chunks per manifest, not epochs
+
+storage:
+  stores_root_dir: /path/to/stores  # MUST be set by user!
+  gnss_store_strategy: skip
+
+logging:
+  log_dir: null  # required for a processing run; set in canvod-settings.yaml
+  worker_log_retention_days: 30
+  log_path_depth: 6

canvod_config-1.0.0/src/canvod/config/defaults/sids.yaml

@@ -0,0 +1,5 @@
+# Default SID configuration: curated multi-GNSS preset (271 SIDs)
+# Override in the sids: section of config/canvod-settings.yaml. Use mode: all to keep every observed SID.
+
+mode: preset
+preset: default

canvod_config-1.0.0/src/canvod/config/defaults/sites.yaml

@@ -0,0 +1,7 @@
+# ============================================================================
+# Default Sites Configuration
+# ============================================================================
+# This is a package default - users MUST define their sites in the sites:
+# section of config/canvod-settings.yaml. Run: just config-init
+
+sites: {}