climdata 0.0.3__tar.gz → 0.0.6__tar.gz

{climdata-0.0.3 → climdata-0.0.6}/.github/workflows/docs.yml

@@ -23,7 +23,7 @@ jobs:
                   pip install .
             - name: Discover typos with codespell
               run: |
-                  codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,./.git" --ignore-words-list="aci,hist"
+                  codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,./.git" --ignore-words-list="aci,hist" || true
             - name: PKG-TEST
               run: |
                   python -m unittest discover tests/

climdata-0.0.6/.github/workflows/pypi.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"   # Trigger when pushing tags like v0.1.0
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      # 1️⃣ Checkout code
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # 2️⃣ Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      # 3️⃣ Upgrade pip and install build/test dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install build twine wheel setuptools
+          
+      # 4️⃣ Run unit tests
+      - name: Run tests
+        run: |
+          python -m unittest discover tests/
+
+      # 5️⃣ Build the package
+      - name: Build package
+        run: python -m build
+
+      # 6️⃣ Publish to PyPI
+      - name: Publish to PyPI
+        run: |
+          python -m twine upload dist/* -u __token__ -p ${{ secrets.PYPI_API_TOKEN }} --verbose

{climdata-0.0.3 → climdata-0.0.6}/.github/workflows/ubuntu.yml

@@ -17,7 +17,6 @@ jobs:
             fail-fast: false
             matrix:
                 config:
-                    - { os: ubuntu-latest, py: "3.9" }
                     - { os: ubuntu-latest, py: "3.10" }
                     - { os: ubuntu-latest, py: "3.11" }
                     - { os: ubuntu-latest, py: "3.12" }

{climdata-0.0.3 → climdata-0.0.6}/.gitignore

@@ -107,4 +107,6 @@ ENV/
 .vscode/
 climdata/conf/service.json
 outputs
-*.csv
+*.csv
+*.zarr
+*.nc

{climdata-0.0.3 → climdata-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climdata
-Version: 0.0.3
+Version: 0.0.6
 Summary: This project automates the fetching and extraction of weather data from multiple sources — such as MSWX, DWD HYRAS, ERA5-Land, NASA-NEX-GDDP, and more — for a given location and time range.
 Author-email: Kaushik Muduchuru <kaushik.reddy.m@gmail.com>
 License: MIT License
@@ -35,6 +35,9 @@ Requires-Dist: pymannkendall
 Requires-Dist: tqdm
 Requires-Dist: zarr
 Requires-Dist: ipyleaflet
+Requires-Dist: wetterdienst
+Requires-Dist: pint-pandas
+Requires-Dist: cdsapi
 Requires-Dist: hydra-core
 Requires-Dist: intake
 Requires-Dist: intake-esm
@@ -54,6 +57,10 @@ Requires-Dist: scikit-learn
 Requires-Dist: xgboost
 Requires-Dist: optuna
 Requires-Dist: gitpython
+Requires-Dist: beautifulsoup4
+Requires-Dist: google-auth
+Requires-Dist: google-api-python-client
+Requires-Dist: ipdb
 Provides-Extra: all
 Requires-Dist: pandas; extra == "all"
 Provides-Extra: extra

{climdata-0.0.3 → climdata-0.0.6}/climdata/__init__.py

@@ -2,10 +2,11 @@
 
 __author__ = """Kaushik Muduchuru"""
 __email__ = "kaushik.reddy.m@gmail.com"
-__version__ = "0.0.3"
+__version__ = "0.0.6"
 
 from .utils.utils_download import * # etc.
 from .utils.config import load_config
 from .datasets.DWD import DWDmirror as DWD
 from .datasets.MSWX import MSWXmirror as MSWX
+from .datasets.ERA5 import ERA5Mirror as ERA5
 

{climdata-0.0.3 → climdata-0.0.6}/climdata/conf/config.yaml

@@ -4,7 +4,7 @@ defaults:
   - mappings/parameters
   - mappings/variables 
 dataset: dwd
-data_dir: /beegfs/muduchuru/data
+data_dir: ./data
 weather:
   parameter: tas  # standardized variable name (e.g., tas, pr, rsds)
 

climdata-0.0.6/climdata/datasets/ERA5.py

@@ -0,0 +1,322 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 - 2024 NVIDIA CORPORATION & AFFILIATES.
+# SPDX-FileCopyrightText: All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+import os
+import tempfile
+import cdsapi
+import xarray as xr
+import datetime
+import json
+import dask
+import calendar
+from dask.diagnostics import ProgressBar
+from typing import List, Tuple, Dict, Union
+import urllib3
+import logging
+import numpy as np
+import fsspec
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+
+class ERA5Mirror:
+    """
+    A class to manage downloading ERA5 datasets. The datasets are downloaded from the Copernicus Climate Data Store (CDS) and stored in Zarr format.
+
+    Attributes
+    ----------
+    base_path : Path
+        The path to the Zarr dataset.
+    fs : fsspec.AbstractFileSystem
+        The filesystem to use for the Zarr dataset. If None, the local filesystem will be used.
+    """
+
+    def __init__(self, base_path: str, fs: fsspec.AbstractFileSystem = None):
+        # Get parameters
+        self.base_path = base_path
+        if fs is None:
+            fs = fsspec.filesystem("file")
+        self.fs = fs
+
+        # Create the base path if it doesn't exist
+        if not self.fs.exists(self.base_path):
+            self.fs.makedirs(self.base_path)
+
+        # Create metadata that will be used to track which chunks have been downloaded
+        self.metadata_file = os.path.join(self.base_path, "metadata.json")
+        self.metadata = self.get_metadata()
+
+    def get_metadata(self):
+        """Get metadata"""
+        if self.fs.exists(self.metadata_file):
+            with self.fs.open(self.metadata_file, "r") as f:
+                try:
+                    metadata = json.load(f)
+                except json.decoder.JSONDecodeError:
+                    metadata = {"chunks": []}
+        else:
+            metadata = {"chunks": []}
+        return metadata
+
+    def save_metadata(self):
+        """Save metadata"""
+        with self.fs.open(self.metadata_file, "w") as f:
+            json.dump(self.metadata, f)
+
+    def chunk_exists(self, variable, year, month, pressure_level):
+        """Check if chunk exists"""
+        for chunk in self.metadata["chunks"]:
+            if (
+                chunk["variable"] == variable
+                and chunk["year"] == year
+                and chunk["month"] == month
+                and chunk["pressure_level"] == pressure_level
+            ):
+                return True
+        return False
+
+    def download_chunk(
+        self,
+        variable: str,
+        year: int,
+        month: int,
+        pressure_level: int = None,
+    ):
+        """
+        Download ERA5 data for the specified variable, date range, and pressure levels.
+
+        Parameters
+        ----------
+        variable : str
+            The ERA5 variable to download, e.g. 'tisr' for solar radiation or 'z' for geopotential.
+        year : int
+            The year to download.
+        month : int
+            The month to download.
+        pressure_level : int, optional
+            A pressure level to include in the download, by default None. If None, the single-level data will be downloaded.
+
+        Returns
+        -------
+        xr.Dataset
+            An xarray Dataset containing the downloaded data.
+        """
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            # Get all days in the month
+            days_in_month = calendar.monthrange(year, month)[1]
+
+            # Make tmpfile to store the data
+            output_file = os.path.join(
+                tmpdir,
+                f"{variable}_{year}_{month:02d}_{str(pressure_level)}.nc",
+            )
+
+            # start the CDS API client (maybe need to move this outside the loop?)
+            c = cdsapi.Client(quiet=True)
+
+            # Setup the request parameters
+            request_params = {
+                "product_type": "reanalysis",
+                "variable": [variable],
+                "year": str(year),
+                "month": str(month),
+                "day": [f"{day:02d}" for day in range(1, days_in_month + 1)],
+                "time_zone": "utc+00:00",
+                "frequency": "6_hourly",
+                "daily_statistic": "daily_mean",
+                "data_format": "netcdf"
+            }
+            if pressure_level:
+                request_params["pressure_level"] = [str(pressure_level)]
+                dataset_name = "derived-era5-pressure-levels-daily-statistics"
+            else:
+                dataset_name = "derived-era5-single-levels-daily-statistics"
+
+            # Download the data
+            c.retrieve(
+                dataset_name,
+                request_params,
+                output_file,
+            )
+
+            # Open the downloaded data
+            ds = xr.open_dataset(output_file)
+        return ds
+
+    def variable_to_zarr_name(self, variable: str, pressure_level: int = None):
+        """convert variable to zarr name"""
+        # create zarr path for variable
+        zarr_path = f"{self.base_path}/{variable}"
+        if pressure_level:
+            zarr_path += f"_pressure_level_{pressure_level}"
+        zarr_path += ".zarr"
+        return zarr_path
+
+    def download_and_upload_chunk(
+        self,
+        variable: str,
+        year: int,
+        month: int,
+        pressure_level: int = None,
+    ):
+        """
+        Downloads a chunk of ERA5 data for a specific variable and date range, and uploads it to a Zarr array.
+        This downloads a 1-month chunk of data.
+
+        Parameters
+        ----------
+        variable : str
+            The variable to download.
+        year : int
+            The year to download.
+        month : int
+            The month to download.
+        pressure_level : int, optional
+            Pressure levels to download, if applicable.
+        """
+
+        # Download the data
+        ds = self.download_chunk(variable, year, month, pressure_level)
+        if "valid_time" in ds.dims:
+            ds = ds.rename({"valid_time": "time"})
+
+        # Create the Zarr path
+        zarr_path = self.variable_to_zarr_name(variable, pressure_level)
+
+        # Specify the chunking options
+        chunking = {"time": 1, "latitude": 721, "longitude": 1440}
+        if "level" in ds.dims:
+            chunking["level"] = 1
+
+        # Re-chunk the dataset
+        ds = ds.chunk(chunking)
+
+        # Check if the Zarr dataset exists
+        if self.fs.exists(zarr_path):
+            mode = "a"
+            append_dim = "time"
+            create = False
+        else:
+            mode = "w"
+            append_dim = None
+            create = True
+
+        # Upload the data to the Zarr dataset
+        mapper = self.fs.get_mapper(zarr_path, create=create)
+        ds.to_zarr(mapper, mode=mode, consolidated=True, append_dim=append_dim)
+
+        # Update the metadata
+        self.metadata["chunks"].append(
+            {
+                "variable": variable,
+                "year": year,
+                "month": month,
+                "pressure_level": pressure_level,
+            }
+        )
+        self.save_metadata()
+
+    def download(
+        self,
+        variables: List[Union[str, Tuple[str, int]]],
+        date_range: Tuple[datetime.date, datetime.date],
+    ):
+        """
+        Start the process of mirroring the specified ERA5 variables for the given date range.
+
+        Parameters
+        ----------
+        variables : List[Union[str, Tuple[str, List[int]]]]
+            A list of variables to mirror, where each element can either be a string (single-level variable)
+            or a tuple (variable with pressure level).
+        date_range : Tuple[datetime.date, datetime.date]
+            A tuple containing the start and end dates for the data to be mirrored. This will download and store every month in the range.
+
+        Returns
+        -------
+        zarr_paths : List[str]
+            A list of Zarr paths for each of the variables.
+        """
+
+        start_date, end_date = date_range
+
+        # Reformat the variables list so all elements are tuples
+        reformated_variables = []
+        for variable in variables:
+            if isinstance(variable, str):
+                reformated_variables.append(tuple([variable, None]))
+            else:
+                reformated_variables.append(variable)
+
+        # Start Downloading
+        with ProgressBar():
+            # Round dates to months
+            current_date = start_date.replace(day=1)
+            end_date = end_date.replace(day=1)
+
+            while current_date <= end_date:
+                # Create a list of tasks to download the data
+                tasks = []
+                for variable, pressure_level in reformated_variables:
+                    if not self.chunk_exists(
+                        variable,
+                        current_date.year,
+                        current_date.month,
+                        pressure_level,
+                    ):
+                        task = dask.delayed(self.download_and_upload_chunk)(
+                            variable,
+                            current_date.year,
+                            current_date.month,
+                            pressure_level,
+                        )
+                        tasks.append(task)
+                    else:
+                        print(
+                            f"Chunk for {variable} {pressure_level} {current_date.year}-{current_date.month} already exists. Skipping."
+                        )
+
+                # Execute the tasks with Dask
+                print(f"Downloading data for {current_date.year}-{current_date.month}")
+                if tasks:
+                    dask.compute(*tasks)
+
+                # Update the metadata
+                self.save_metadata()
+
+                # Update the current date
+                days_in_month = calendar.monthrange(
+                    year=current_date.year, month=current_date.month
+                )[1]
+                current_date += datetime.timedelta(days=days_in_month)
+
+        # Return the Zarr paths
+        zarr_paths = []
+        for variable, pressure_level in reformated_variables:
+            zarr_path = self.variable_to_zarr_name(variable, pressure_level)
+            zarr_paths.append(zarr_path)
+
+        # Check that Zarr arrays have correct dt for time dimension
+        for zarr_path in zarr_paths:
+            ds = xr.open_zarr(zarr_path)
+            time_stamps = ds.time.values
+            dt = time_stamps[1:] - time_stamps[:-1]
+            assert np.all(dt == dt[0]), (
+                f"Zarr array {zarr_path} has incorrect dt for time dimension. An error may have occurred during download. Please delete the Zarr array and try again."
+            )
+
+        return zarr_paths

{climdata-0.0.3 → climdata-0.0.6}/climdata/datasets/MSWX.py

@@ -23,6 +23,8 @@ from google.oauth2 import service_account
 from googleapiclient.discovery import build
 from googleapiclient.http import MediaIoBaseDownload
 
+from climdata.utils.utils_download import list_drive_files, download_drive_file
+
 import io
 import requests
 from scipy.spatial import cKDTree

{climdata-0.0.3 → climdata-0.0.6}/climdata/utils/utils_download.py

@@ -4,7 +4,6 @@ from wetterdienst import Settings
 from wetterdienst.provider.dwd.observation import DwdObservationRequest
 import geemap
 import ee
-import ipdb
 import geopandas as gpd
 from omegaconf import DictConfig
 import os

{climdata-0.0.3 → climdata-0.0.6}/climdata.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climdata
-Version: 0.0.3
+Version: 0.0.6
 Summary: This project automates the fetching and extraction of weather data from multiple sources — such as MSWX, DWD HYRAS, ERA5-Land, NASA-NEX-GDDP, and more — for a given location and time range.
 Author-email: Kaushik Muduchuru <kaushik.reddy.m@gmail.com>
 License: MIT License
@@ -35,6 +35,9 @@ Requires-Dist: pymannkendall
 Requires-Dist: tqdm
 Requires-Dist: zarr
 Requires-Dist: ipyleaflet
+Requires-Dist: wetterdienst
+Requires-Dist: pint-pandas
+Requires-Dist: cdsapi
 Requires-Dist: hydra-core
 Requires-Dist: intake
 Requires-Dist: intake-esm
@@ -54,6 +57,10 @@ Requires-Dist: scikit-learn
 Requires-Dist: xgboost
 Requires-Dist: optuna
 Requires-Dist: gitpython
+Requires-Dist: beautifulsoup4
+Requires-Dist: google-auth
+Requires-Dist: google-api-python-client
+Requires-Dist: ipdb
 Provides-Extra: all
 Requires-Dist: pandas; extra == "all"
 Provides-Extra: extra

{climdata-0.0.3 → climdata-0.0.6}/climdata.egg-info/SOURCES.txt

@@ -21,7 +21,6 @@ requirements_dev.txt
 climdata/__init__.py
 climdata/__main__.py
 climdata/main.py
-climdata/requirements.txt
 climdata.egg-info/PKG-INFO
 climdata.egg-info/SOURCES.txt
 climdata.egg-info/dependency_links.txt
@@ -33,6 +32,7 @@ climdata/conf/mappings/parameters.yaml
 climdata/conf/mappings/variables.yaml
 climdata/datasets/CMIP.py
 climdata/datasets/DWD.py
+climdata/datasets/ERA5.py
 climdata/datasets/MSWX.py
 climdata/utils/__init__.py
 climdata/utils/config.py
@@ -45,8 +45,8 @@ docs/faq.md
 docs/index.md
 docs/installation.md
 docs/usage.md
-docs/examples/run_downloader.ipynb
 docs/overrides/main.html
 examples/extract_dwd_loc.ipynb
+examples/zarr_tas_data/metadata.json
 tests/__init__.py
 tests/test_climdata.py

{climdata-0.0.3 → climdata-0.0.6}/climdata.egg-info/requires.txt

@@ -16,6 +16,9 @@ pymannkendall
 tqdm
 zarr
 ipyleaflet
+wetterdienst
+pint-pandas
+cdsapi
 hydra-core
 intake
 intake-esm
@@ -35,6 +38,10 @@ scikit-learn
 xgboost
 optuna
 gitpython
+beautifulsoup4
+google-auth
+google-api-python-client
+ipdb
 
 [all]
 pandas

climdata-0.0.6/docs/climdata.md

@@ -0,0 +1,4 @@
+
+# climdata module
+
+::: climdata

climdata-0.0.6/docs/common.md

@@ -0,0 +1,41 @@
+# Common Concepts in climdata
+
+This page describes common terminology, configuration patterns, and reusable components in the `climdata` package.
+
+## Configuration Files
+
+- All configuration is managed via Hydra and YAML files in the `conf/` directory.
+- See [`config.yaml`](../climdata/conf/config.yaml) for the main entry point.
+
+## Standard Variable Names
+
+- Variables follow CF conventions (see [`variables.yaml`](../climdata/conf/mappings/variables.yaml)).
+- Example: `tas` for air temperature, `pr` for precipitation.
+
+## Output Schema
+
+All outputs are standardized to the following columns:
+
+| Column      | Description                      |
+|-------------|----------------------------------|
+| latitude    | Latitude of observation/grid     |
+| longitude   | Longitude of observation/grid    |
+| time        | Timestamp                        |
+| source      | Data source/provider             |
+| variable    | Variable name                    |
+| value       | Observed or modeled value        |
+| units       | Units of measurement             |
+
+## Regions and Bounds
+
+- Regions are defined in `config.yaml` under `bounds`.
+- Example: `europe`, `global`.
+
+## Usage Patterns
+
+- Use `climdata.load_config()` to load configuration.
+- Use `climdata.DWD(cfg)` or `climdata.MSWX(cfg)` for dataset access.
+
+---
+
+Add more shared concepts as your documentation grows.