Metadata-Version: 2.1
Name: pyclimproj
Version: 2025.5.30
Summary: A simple climate projection downloader for ORNL Hydro9505 data
Author-email: Surabhi Upadhyay <surabhiupadhyay7@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/surabhiupadhyay/pyclimproj
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: beautifulsoup4
Requires-Dist: tqdm

# pyclimproj

**pyclimproj** is a Python package for downloading, pre-processing, and visualizing CMIP6-based hydroclimatic projection data hosted on the [ORNL HydroSource SWA9505V3 portal](https://hydrosource2.ornl.gov/files/SWA9505V3/).  

The SWA9505V3 archive contains CMIP6-based hydrologic projections (e.g., precipitation, temperature, snowpack, runoff) bias-corrected and spatially disaggregated to CONUS scales. This package simplifies the process of recursively browsing directories, filtering relevant NetCDF files by variable or scenario, and downloading them locally for further scientific analysis.

---

## Features

- **Recursive folder scanning** to explore model subdirectories
- **Selective NetCDF download** using variable keywords or file patterns
- **Base URL independence** — works with any structured file server like the ORNL HydroSource portal
- Easily integrates with `xarray`, `netCDF4`, or `matplotlib` for downstream analysis
- Organizes files locally while preserving folder structure

## Installation

### Option 1: Install using pip

```bash
pip install pyclimproj
```

### Option 2: Clone and install locally

```bash
git clone https://github.com/your-username/pyclimproj.git
cd pyclimproj
pip install .
```

### Requirements
This package requires: requests and beautifulsoup4

You can install them manually if needed:
pip install requests beautifulsoup4

---

### License
This project is licensed under the MIT License.

### Author
Surabhi Upadhyay
GitHub: @surabhiupadhyay

### Contributions
Issues, suggestions, or improvements are welcome!
Please open a GitHub issue or submit a pull request.






