climdata 0.0.3__tar.gz → 0.0.5__tar.gz

{climdata-0.0.3 → climdata-0.0.5}/.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.5/.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.5}/.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.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climdata
-Version: 0.0.3
+Version: 0.0.5
 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,8 @@ Requires-Dist: pymannkendall
 Requires-Dist: tqdm
 Requires-Dist: zarr
 Requires-Dist: ipyleaflet
+Requires-Dist: wetterdienst
+Requires-Dist: pint-pandas
 Requires-Dist: hydra-core
 Requires-Dist: intake
 Requires-Dist: intake-esm
@@ -54,6 +56,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.5}/climdata/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Kaushik Muduchuru"""
 __email__ = "kaushik.reddy.m@gmail.com"
-__version__ = "0.0.3"
+__version__ = "0.0.5"
 
 from .utils.utils_download import * # etc.
 from .utils.config import load_config

{climdata-0.0.3 → climdata-0.0.5}/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.5}/climdata.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climdata
-Version: 0.0.3
+Version: 0.0.5
 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,8 @@ Requires-Dist: pymannkendall
 Requires-Dist: tqdm
 Requires-Dist: zarr
 Requires-Dist: ipyleaflet
+Requires-Dist: wetterdienst
+Requires-Dist: pint-pandas
 Requires-Dist: hydra-core
 Requires-Dist: intake
 Requires-Dist: intake-esm
@@ -54,6 +56,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.5}/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
@@ -45,7 +44,6 @@ 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
 tests/__init__.py

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

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

climdata-0.0.5/docs/climdata.md

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

climdata-0.0.5/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.

climdata-0.0.5/docs/index.md

@@ -0,0 +1,193 @@
+# Welcome to climdata
+
+
+
+[![image](https://img.shields.io/pypi/v/climdata.svg)](https://pypi.python.org/pypi/climdata)
+[![image](https://img.shields.io/conda/vn/conda-forge/climdata.svg)](https://anaconda.org/conda-forge/climdata)
+
+
+**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.**
+
+
+-   Free software: MIT License
+-   Documentation: https://Kaushikreddym.github.io/climdata
+    
+
+## 📦 Data Sources
+
+This project utilizes climate and weather datasets from a variety of data sources:
+
+- **DWD Station Data**  
+  Retrieved using the [DWD API](https://wetterdienst.readthedocs.io/en/latest/index.html). Provides high-resolution observational data from Germany's national meteorological service.
+
+- **MSWX (Multi-Source Weather)**  
+  Accessed via [GloH2O's Google Drive](https://www.gloh2o.org/mswx/). Combines multiple satellite and reanalysis datasets for global gridded weather variables.
+
+- **DWD HYRAS**  
+  Downloaded from the [DWD Open Data FTP Server](https://opendata.dwd.de/). Offers gridded observational data for Central Europe, useful for hydrological applications.
+
+- **ERA5, ERA5-Land**  
+  Accessed through the [Google Earth Engine](https://developers.google.com/earth-engine/datasets/catalog). Provides reanalysis datasets from ECMWF with high temporal and spatial resolution.
+
+- **NASA NEX-GDDP**  
+  Also retrieved via Earth Engine. Downscaled CMIP5/CMIP6 climate projections developed by NASA for local-scale impact assessment.
+
+- **CMIP6**  
+  Obtained using [ESGPull](https://esgf.github.io/esgf-download/) from the ESGF data nodes. Includes multi-model climate simulations following various future scenarios.
+
+It supports:
+✅ Automatic file download (e.g., from Google Drive or online servers)  
+✅ Flexible configuration via `config.yaml`  
+✅ Time series extraction for a user-specified latitude/longitude  
+✅ Batch processing for many locations from a CSV file
+
+
+## 🚀 How to Run and Explore Configurations
+
+### ✅ Run a download job with custom overrides
+
+You can run the data download script and override any configuration value directly in the command line using [Hydra](https://hydra.cc/).
+
+For example, to download **ERA5-Land** data for **January 1–4, 2020**, run:
+
+```bash
+python download_location.py dataset='era5-land' \
+  time_range.start_date='2020-01-01' \
+  time_range.end_date='2020-01-04' \
+  location.lat=52.5200 \
+  location.lon=13.4050
+```
+
+For downloading multiple locations from a csv file `locations.csv`, run:
+
+```bash
+python download_csv.py dataset='era5-land' \
+  time_range.start_date='2020-01-01' \
+  time_range.end_date='2020-01-04' \
+```
+
+an example `locations.csv` can be
+
+```csv
+lat,lon,city
+52.5200,13.4050,berlin
+48.1351,11.5820,munich
+53.5511,9.9937,hamburg
+```
+
+**What this does:**
+
+- `dataset='era5-land'` tells the script which dataset to use.
+- `time_range.start_date` and `time_range.end_date` override the default dates in your YAML config.
+- All other settings use your existing `config.yaml` in the `conf` folder.
+
+---
+
+### ✅ List all available datasets defined in your configuration
+
+To see what datasets are available (without running the downloader), you can dump the **resolved configuration** and filter it using [`yq`](https://github.com/mikefarah/yq).
+
+Run:
+
+```bash
+python download_location.py --cfg job | yq '.mappings | keys'
+```
+
+**What this does:**
+
+- `--cfg job` tells Hydra to output the final resolved configuration and exit.
+- `| yq '.mappings | keys'` filters the output to show only the dataset names defined under the `mappings` section.
+
+---
+
+### ⚡️ Tip
+
+- Make sure `yq` is installed:
+  ```bash
+  brew install yq   # macOS
+  # OR
+  pip install yq
+  ```
+
+- To see available variables for a specific dataset (for example `mswx`), run:
+  ```bash
+  python download_location.py --cfg job | yq '.mappings.mswx.variables | keys'
+  ```
+
+---
+
+---
+
+## ⚙️ **Key Features**
+
+- **Supports multiple weather data providers**
+- **Uses `xarray` for robust gridded data extraction**
+- **Handles curvilinear and rectilinear grids**
+- **Uses a Google Drive Service Account for secure downloads**
+- **Easily reproducible runs using Hydra**
+
+---
+## 📡 Google Drive API Setup
+
+This project uses the **Google Drive API** with a **Service Account** to securely download weather data files from a shared Google Drive folder.
+
+Follow these steps to set it up correctly:
+
+---
+
+### ✅ 1. Create a Google Cloud Project
+
+- Go to [Google Cloud Console](https://console.cloud.google.com/).
+- Click **“Select Project”** → **“New Project”**.
+- Enter a project name (e.g. `WeatherDataDownloader`).
+- Click **“Create”**.
+
+---
+
+### ✅ 2. Enable the Google Drive API
+
+- In the left sidebar, go to **APIs & Services → Library**.
+- Search for **“Google Drive API”**.
+- Click it, then click **“Enable”**.
+
+---
+
+### ✅ 3. Create a Service Account
+
+- Go to **IAM & Admin → Service Accounts**.
+- Click **“Create Service Account”**.
+- Enter a name (e.g. `weather-downloader-sa`).
+- Click **“Create and Continue”**. You can skip assigning roles for read-only Drive access.
+- Click **“Done”** to finish.
+
+---
+
+### ✅ 4. Create and Download a JSON Key
+
+- After creating the Service Account, click on its email address to open its details.
+- Go to the **“Keys”** tab.
+- Click **“Add Key” → “Create new key”** → choose **`JSON`** → click **“Create”**.
+- A `.json` key file will download automatically. **Store it securely!**
+
+### ✅ 5. Store the JSON Key Securely
+
+- Place the downloaded `.json` key in the conf folder with the name service.json. 
+
+
+## Setup Instructions fro ERA5 api
+
+### 1. CDS API Key Setup
+
+1. Create a free account on the
+[Copernicus Climate Data Store](https://cds.climate.copernicus.eu/user/register)
+2. Once logged in, go to your [user profile](https://cds.climate.copernicus.eu/user)
+3. Click on the "Show API key" button
+4. Create the file `~/.cdsapirc` with the following content:
+
+   ```bash
+   url: https://cds.climate.copernicus.eu/api/v2
+   key: <your-api-key-here>
+   ```
+
+5. Make sure the file has the correct permissions: `chmod 600 ~/.cdsapirc`
+

{climdata-0.0.3 → climdata-0.0.5}/examples/extract_dwd_loc.ipynb

@@ -64,59 +64,6 @@
     "                      ])"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e90e98ba",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/html": [
-       "\n",
-       "            <style>\n",
-       "                .geemap-dark {\n",
-       "                    --jp-widgets-color: white;\n",
-       "                    --jp-widgets-label-color: white;\n",
-       "                    --jp-ui-font-color1: white;\n",
-       "                    --jp-layout-color2: #454545;\n",
-       "                    background-color: #383838;\n",
-       "                }\n",
-       "\n",
-       "                .geemap-dark .jupyter-button {\n",
-       "                    --jp-layout-color3: #383838;\n",
-       "                }\n",
-       "\n",
-       "                .geemap-colab {\n",
-       "                    background-color: var(--colab-primary-surface-color, white);\n",
-       "                }\n",
-       "\n",
-       "                .geemap-colab .jupyter-button {\n",
-       "                    --jp-layout-color3: var(--colab-primary-surface-color, white);\n",
-       "                }\n",
-       "            </style>\n",
-       "            "
-      ],
-      "text/plain": [
-       "<IPython.core.display.HTML object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'degC'"
-      ]
-     },
-     "execution_count": 9,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": []
-  },
   {
    "cell_type": "code",
    "execution_count": 10,
@@ -1130,7 +1077,7 @@
   "kernelspec": {
    "display_name": "sdba",
    "language": "python",
-   "name": "sdba"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {

{climdata-0.0.3 → climdata-0.0.5}/mkdocs.yml

@@ -9,8 +9,6 @@ copyright: "Copyright © 2024 - 2024 Kaushik Muduchuru"
 theme:
     palette:
         - scheme: default
-          #   primary: blue
-          #   accent: indigo
           toggle:
               icon: material/toggle-switch-off-outline
               name: Switch to dark mode
@@ -23,31 +21,32 @@ theme:
     name: material
     icon:
         repo: fontawesome/brands/github
-    # logo: assets/logo.png
-    # favicon: assets/favicon.png
+    custom_dir: "docs/overrides"
+    font:
+        text: Google Sans
+        code: Regular
     features:
         - navigation.instant
         - navigation.tracking
         - navigation.top
         - search.highlight
         - search.share
-    custom_dir: "docs/overrides"
-    font:
-        text: Google Sans
-        code: Regular
 
 plugins:
     - search
-    - mkdocstrings
+    - mkdocstrings:
+          handlers:
+              python:
+                  options:
+                      show_root_heading: true
     - git-revision-date
     - git-revision-date-localized:
           enable_creation_date: true
           type: timeago
-    # - pdf-export
     - mkdocs-jupyter:
-          include_source: True
-          ignore_h1_titles: True
-          execute: True
+          include_source: true
+          ignore_h1_titles: true
+          execute: false
           allow_errors: false
           ignore: ["conf.py"]
           execute_ignore: ["*ignore.ipynb"]
@@ -66,11 +65,6 @@ markdown_extensions:
     - toc:
           permalink: true
 
-# extra:
-#     analytics:
-#         provider: google
-#         property: UA-XXXXXXXXX-X
-
 nav:
     - Home: index.md
     - Installation: installation.md
@@ -80,7 +74,9 @@ nav:
     - Changelog: changelog.md
     - Report Issues: https://github.com/Kaushikreddym/climdata/issues
     - Examples:
-        - examples/intro.ipynb
+        - Intro Notebook: examples/intro.ipynb
+        - Downloader Notebook: examples/run_downloader.ipynb
     - API Reference:
-          - climdata module: climdata.md
-          - common module: common.md
+        - climdata package: climdata   # points to top-level package, not climdata.climdata
+        - utils module: climdata.utils
+        - datasets module: climdata.datasets

{climdata-0.0.3 → climdata-0.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "climdata"
-version = "0.0.3"
+version = "0.0.5"
 dynamic = [
     "dependencies",
 ]
@@ -52,7 +52,7 @@ universal = true
 
 
 [tool.bumpversion]
-current_version = "0.0.3"
+current_version = "0.0.5"
 commit = true
 tag = true
 

{climdata-0.0.3 → climdata-0.0.5}/requirements.txt

@@ -17,6 +17,8 @@ pymannkendall
 tqdm
 zarr
 ipyleaflet
+wetterdienst
+pint-pandas
 
 # Workflow + config
 hydra-core
@@ -46,3 +48,7 @@ optuna
 
 # Dev tools
 gitpython
+beautifulsoup4
+google-auth
+google-api-python-client
+ipdb

climdata-0.0.5/tests/test_climdata.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+
+import unittest
+import climdata
+
+class TestClimdata(unittest.TestCase):
+    def test_version(self):
+        self.assertIsNotNone(climdata.__version__)
+

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

@@ -1,34 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - "v*"   # trigger when pushing tags like v0.1.0
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Install build dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build twine
-
-      - name: Build package
-        run: python -m build
-
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}

climdata-0.0.3/climdata/requirements.txt

@@ -1,20 +0,0 @@
-beautifulsoup4==4.13.5
-earthengine_api==1.5.19
-geemap==0.35.3
-geopandas==1.0.1
-google_api_python_client==2.172.0
-hydra-core==1.3.2
-ipdb==0.13.13
-numpy==2.3.2
-omegaconf==2.3.0
-pandas==2.3.2
-Pint==0.24.4
-Pint_Pandas==0.7.1
-protobuf==6.32.0
-PyYAML==6.0.2
-PyYAML==6.0.2
-Requests==2.32.5
-scipy==1.16.1
-tqdm==4.67.1
-wetterdienst==0.111.0
-xarray==2025.4.0

climdata-0.0.3/docs/climdata.md

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

climdata-0.0.3/docs/common.md

@@ -1,3 +0,0 @@
-# common module
-
-::: climdata.common