Welcome to Varunayan’s Documentation!

Welcome to Varunayan’s Documentation!#

What is Varunayan?

Varunayan = Varun + ayan

  • Varun in the vedic mythology was the god of sky, order, truth, water and magic.

  • Ayan means path in Sanskrit.

  • Varunayan: A smooth path to access clean climate data

Varunayan is a Python package for downloading and processing ERA5 climate data. It provides both command-line and Python APIs for extracting analysis-ready climate data for custom geographical regions using:

  • GeoJSON files

  • Bounding boxes

  • Point coordinates

Stop spending hours on data wrangling. Focus on your research — Varunayan takes care of the climate data.

Quick Start#

Installation#

pip install git+https://github.com/saketlab/varunayan

Usage Examples#

import varunayan

# Download temperature data for a region
df = varunayan.era5ify_geojson(
    request_id="my_analysis",
    variables=["2m_temperature", "total_precipitation"],
    start_date="2023-01-01",
    end_date="2023-01-31",
    json_file="region.geojson",
    frequency="daily"
)

varunayan geojson \
    --request-id "my_analysis" \
    --variables "2m_temperature,total_precipitation" \
    --start-date "2023-01-01" \
    --end-date "2023-01-31" \
    --json-file "region.geojson" \
    --frequency "daily"

Need Help?

Documentation Contents#

Getting Started

Tutorials & Examples

API Reference

Development

Contributing#

We welcome contributions! Please see our GitHub repository for:

  • Bug reports

  • Feature requests

  • Documentation improvements

  • Code contributions

License#

This project is licensed under the MIT License. See the LICENSE file for details.

Contents