cdo-toolkit 0.1.0__tar.gz

cdo_toolkit-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+dist/
+*.egg-info/
+logs/
+.venv/

cdo_toolkit-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Institut Pierre-Simon Laplace (IPSL) and contributors
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cdo_toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: cdo-toolkit
+Version: 0.1.0
+Summary: CDO-based NetCDF regridding with chunking, parallel workers, and optional CMIP filename helpers
+Project-URL: Repository, https://github.com/orlando-code/cdo-toolkit
+Project-URL: Documentation, https://github.com/orlando-code/cdo-toolkit#readme
+Project-URL: Issues, https://github.com/orlando-code/cdo-toolkit/issues
+Author-email: Orlando Timmerman <rt582@cam.ac.uk>
+License: BSD-3-Clause
+License-File: LICENSE
+Keywords: cdo,climate,netcdf,regridding,xarray
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: cdo>=1.6.1
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: psutil>=7.2.2
+Requires-Dist: rich>=12.6.0
+Requires-Dist: xarray>=2023.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cdo-toolkit
+
+CDO-based NetCDF regridding toolkit: weight caching, time-chunked processing, parallel workers, Rich progress UI, and optional surface/seafloor level extraction.
+
+Works with **general NetCDF files**. CMIP6 filename helpers (`tos_Omon_...` variable filtering, `nominal_resolution` metadata) live in `cdo_toolkit.cmip` but are optional.
+
+## Requirements
+
+- Python ≥ 3.10
+- [CDO](https://code.mpimet.mpg.de/projects/cdo) binary on `PATH` (e.g. `conda install -c conda-forge cdo`)
+
+## Install
+
+```bash
+pip install cdo-toolkit
+# editable from source
+pip install -e .
+```
+
+## CLI
+
+```bash
+cdo-toolkit /path/to/data -o /path/to/out -r 1.0 1.0 -w 4
+python -m cdo_toolkit /path/to/file.nc --extract-surface
+```
+
+## Python API
+
+```python
+from pathlib import Path
+from cdo_toolkit import CDORegridPipeline, regrid_directory, regrid_single_file
+
+regrid_directory(Path("data/"), target_resolution=(1.0, 1.0), max_workers=8)
+```
+
+## Package layout
+
+| Module | Role |
+|--------|------|
+| `pipeline` | `CDORegridPipeline` core |
+| `api` | High-level `regrid_directory`, `regrid_single_file`, … |
+| `workers` | Process-pool worker entrypoints |
+| `ui` | Rich progress bars |
+| `cmip` | Optional CMIP6 filename/metadata helpers |
+| `paths` | Weight-cache and intermediate-file path helpers |
+
+## License
+
+BSD-3-Clause

cdo_toolkit-0.1.0/README.md

@@ -0,0 +1,49 @@
+# cdo-toolkit
+
+CDO-based NetCDF regridding toolkit: weight caching, time-chunked processing, parallel workers, Rich progress UI, and optional surface/seafloor level extraction.
+
+Works with **general NetCDF files**. CMIP6 filename helpers (`tos_Omon_...` variable filtering, `nominal_resolution` metadata) live in `cdo_toolkit.cmip` but are optional.
+
+## Requirements
+
+- Python ≥ 3.10
+- [CDO](https://code.mpimet.mpg.de/projects/cdo) binary on `PATH` (e.g. `conda install -c conda-forge cdo`)
+
+## Install
+
+```bash
+pip install cdo-toolkit
+# editable from source
+pip install -e .
+```
+
+## CLI
+
+```bash
+cdo-toolkit /path/to/data -o /path/to/out -r 1.0 1.0 -w 4
+python -m cdo_toolkit /path/to/file.nc --extract-surface
+```
+
+## Python API
+
+```python
+from pathlib import Path
+from cdo_toolkit import CDORegridPipeline, regrid_directory, regrid_single_file
+
+regrid_directory(Path("data/"), target_resolution=(1.0, 1.0), max_workers=8)
+```
+
+## Package layout
+
+| Module | Role |
+|--------|------|
+| `pipeline` | `CDORegridPipeline` core |
+| `api` | High-level `regrid_directory`, `regrid_single_file`, … |
+| `workers` | Process-pool worker entrypoints |
+| `ui` | Rich progress bars |
+| `cmip` | Optional CMIP6 filename/metadata helpers |
+| `paths` | Weight-cache and intermediate-file path helpers |
+
+## License
+
+BSD-3-Clause

cdo_toolkit-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cdo-toolkit"
+version = "0.1.0"
+description = "CDO-based NetCDF regridding with chunking, parallel workers, and optional CMIP filename helpers"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "BSD-3-Clause" }
+authors = [{ name = "Orlando Timmerman", email = "rt582@cam.ac.uk" }]
+keywords = ["netcdf", "regridding", "cdo", "climate", "xarray"]
+classifiers = [
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "cdo>=1.6.1",
+    "numpy>=1.24.0",
+    "psutil>=7.2.2",
+    "rich>=12.6.0",
+    "xarray>=2023.1.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.3",
+]
+
+[project.scripts]
+cdo-toolkit = "cdo_toolkit.cli:main"
+
+[project.urls]
+Repository = "https://github.com/orlando-code/cdo-toolkit"
+Documentation = "https://github.com/orlando-code/cdo-toolkit#readme"
+Issues = "https://github.com/orlando-code/cdo-toolkit/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cdo_toolkit"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra -q"

cdo_toolkit-0.1.0/requirements-dev.lock

@@ -0,0 +1,44 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+cdo==1.6.1
+    # via cdo-toolkit
+markdown-it-py==4.2.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+numpy==2.2.6
+    # via cdo-toolkit
+    # via pandas
+    # via xarray
+packaging==26.2
+    # via cdo
+    # via xarray
+pandas==2.3.3
+    # via xarray
+psutil==7.2.2
+    # via cdo-toolkit
+pygments==2.20.0
+    # via rich
+python-dateutil==2.9.0.post0
+    # via pandas
+pytz==2026.2
+    # via pandas
+rich==15.0.0
+    # via cdo-toolkit
+six==1.17.0
+    # via cdo
+    # via python-dateutil
+tzdata==2026.2
+    # via pandas
+xarray==2025.6.1
+    # via cdo-toolkit

cdo_toolkit-0.1.0/requirements.lock

@@ -0,0 +1,44 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+cdo==1.6.1
+    # via cdo-toolkit
+markdown-it-py==4.2.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+numpy==2.2.6
+    # via cdo-toolkit
+    # via pandas
+    # via xarray
+packaging==26.2
+    # via cdo
+    # via xarray
+pandas==2.3.3
+    # via xarray
+psutil==7.2.2
+    # via cdo-toolkit
+pygments==2.20.0
+    # via rich
+python-dateutil==2.9.0.post0
+    # via pandas
+pytz==2026.2
+    # via pandas
+rich==15.0.0
+    # via cdo-toolkit
+six==1.17.0
+    # via cdo
+    # via python-dateutil
+tzdata==2026.2
+    # via pandas
+xarray==2025.6.1
+    # via cdo-toolkit

cdo_toolkit-0.1.0/src/cdo_toolkit/__init__.py

@@ -0,0 +1,47 @@
+"""CDO-based NetCDF regridding toolkit."""
+
+from cdo_toolkit.api import (
+    extract_seafloor_single_file,
+    regrid_directory,
+    regrid_directory_both_levels,
+    regrid_large_files,
+    regrid_single_file,
+    regrid_single_file_both_levels,
+    regrid_single_file_extreme_levels,
+)
+from cdo_toolkit.cmip import (
+    filter_files_by_variables,
+    get_cmip_variable_name,
+    parse_variable_list,
+    pick_representative_file,
+    representative_files_by_directory,
+)
+from cdo_toolkit.errors import default_log_dir, init_regrid_error_log, log_regrid_error
+from cdo_toolkit.paths import is_intermediate_nc, is_weights_or_cache_file, weight_cache_dir_for_input
+from cdo_toolkit.pipeline import CDORegridPipeline
+from cdo_toolkit.workers import process_single_file_standalone
+
+__all__ = [
+    "CDORegridPipeline",
+    "default_log_dir",
+    "extract_seafloor_single_file",
+    "filter_files_by_variables",
+    "get_cmip_variable_name",
+    "init_regrid_error_log",
+    "is_intermediate_nc",
+    "is_weights_or_cache_file",
+    "log_regrid_error",
+    "parse_variable_list",
+    "pick_representative_file",
+    "process_single_file_standalone",
+    "representative_files_by_directory",
+    "regrid_directory",
+    "regrid_directory_both_levels",
+    "regrid_large_files",
+    "regrid_single_file",
+    "regrid_single_file_both_levels",
+    "regrid_single_file_extreme_levels",
+    "weight_cache_dir_for_input",
+]
+
+__version__ = "0.1.0"

cdo_toolkit-0.1.0/src/cdo_toolkit/__main__.py

@@ -0,0 +1,6 @@
+"""Allow ``python -m cdo_toolkit``."""
+
+from cdo_toolkit.cli import main
+
+if __name__ == "__main__":
+    main()