Update documentation

Author: saketkc

docs/conf.py

@@ -1,7 +1,4 @@
 # Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import importlib
 import os
@@ -14,21 +11,15 @@
 except Exception:
     package_version = "0.2.0"
 
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
 project = "varunayan"
-copyright = "2025, Atharva Jagtap and Saket Choudhary"
+copyright = "2026, Atharva Jagtap and Saket Choudhary"
 author = "Atharva Jagtap and Saket Choudhary"
 release = package_version
 version = os.environ.get("SMV_CURRENT_VERSION") or os.environ.get(
     "READTHEDOCS_VERSION_NAME",
     release,
 )
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
@@ -38,14 +29,15 @@
     "myst_nb",
     "sphinx_multiversion",
     "sphinx_copybutton",
+    "sphinxext.opengraph",
+    "sphinx_sitemap",
 ]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "tutorials/*.ipynb"]
 
 language = "en"
 
-# -- Autodoc configuration --------------------------------------------------
 autodoc_default_options = {
     "members": True,
     "member-order": "bysource",
@@ -54,8 +46,6 @@
     "exclude-members": "__weakref__",
 }
 
-# Mock heavy optional dependencies if they are unavailable so autodoc can
-# import varunayan modules without requiring compiled geospatial stacks.
 _OPTIONAL_LIBS = [
     "geopandas",
     "geopy",
@@ -73,7 +63,6 @@
     except Exception:
         autodoc_mock_imports.append(_module)  # type:ignore
 
-# -- Napoleon settings -------------------------------------------------------
 napoleon_google_docstring = True
 napoleon_numpy_docstring = True
 napoleon_include_init_with_doc = False
@@ -86,24 +75,19 @@
 napoleon_use_param = True
 napoleon_use_rtype = True
 
-# -- Intersphinx mapping ----------------------------------------------------
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "pandas": ("https://pandas.pydata.org/docs/", None),
     "requests": ("https://requests.readthedocs.io/en/latest/", None),
 }
 
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
 html_theme = "furo"
 html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 
-# Documentation title without version
-html_title = f"{project} Documentation"
+html_title = "varunayan — Climate Data Toolkit"
+html_baseurl = "https://varunayan.saketlab.org/"
 
-# Logo configuration
 html_logo = "assets/varunayan.png"
 
 html_sidebars = {
@@ -117,10 +101,9 @@
     ]
 }
 
-# -- Theme options -----------------------------------------------------------
 html_theme_options = {
     "navigation_with_keys": True,
-    "sidebar_hide_name": False,  # Show name alongside logo
+    "sidebar_hide_name": False, 
     "light_css_variables": {
         "color-brand-primary": "#1b1b1f",
         "color-brand-content": "#1b1b1f",
@@ -135,26 +118,21 @@
     },
 }
 
-# Set default color scheme to dark
 html_css_files = ["css/custom.css"]
 
-# MyST-NB configuration
 nb_execution_mode = "off"
 nb_render_plugin = "default"
 nb_merge_streams = True
 
-# Enable copy button for code cells
 nb_code_prompt_show = "Show code cell {type}"
 nb_code_prompt_hide = "Hide code cell {type}"
 
-# Sphinx copybutton configuration
 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 copybutton_prompt_is_regexp = True
 copybutton_only_copy_prompt_lines = True
 copybutton_remove_prompts = True
 copybutton_copy_empty_lines = False
 
-# Sphinx multiversion settings
 smv_branch_whitelist = os.environ.get(
     "SMV_BRANCH_WHITELIST",
     r"^(master|main|develop)$",
@@ -165,5 +143,12 @@
 smv_latest_version = os.environ.get("SMV_LATEST_VERSION", "main")
 smv_rename_latest_version = "latest"
 
-# Prefer tags over branches for version selection
 smv_prefer_remote_refs = True
+
+html_extra_path = ["robots.txt", "llms.txt"]
+
+ogp_site_url = "https://varunayan.saketlab.org/"
+ogp_site_name = "varunayan"
+ogp_image = "https://varunayan.saketlab.org/_static/varunayan_og.png"
+ogp_description_length = 200
+ogp_type = "website"

docs/index.rst

@@ -1,7 +1,7 @@
-varunayan: Download and Process ERA5 Climate Data
-==================================================
+varunayan: Climate Data Toolkit
+================================
 
-A Python package for downloading and processing ERA5 climate data with support for custom geographical regions:
+Download and process climate reanalysis and observational data from ERA5, IMD, HadEX3, and CRU TS. Compute heat stress indices (UTCI, WBGT, Heat Index, Humidex). Aggregate country-level temperature series. Built with a focus on India, but works globally wherever the underlying datasets have coverage.
 
 .. image:: https://img.shields.io/pypi/v/varunayan.svg
    :target: https://pypi.org/project/varunayan/
@@ -15,73 +15,74 @@ A Python package for downloading and processing ERA5 climate data with support f
    :target: https://github.com/saketlab/varunayan/blob/main/LICENSE
    :alt: License
 
-Overview
---------
-
-varunayan provides a simple and powerful interface to download and process ERA5 climate data from the Copernicus Climate Data Store. It supports:
-
 .. note::
 
-   **R users**: Check out `varunayanR <https://saketlab.github.io/varunayanR>`_, the R companion package for varunayan.
-
-- **Custom geographical regions**: Use GeoJSON files, bounding boxes, or point coordinates
-- **Multiple variables**: Download any ERA5 variable (temperature, precipitation, wind, etc.)
-- **Flexible time periods**: From hourly to yearly data aggregation
-- **Automatic processing**: Spatial filtering, temporal aggregation, and CSV output
-- **Chunking support**: Handle large requests efficiently with automatic time-based chunking
+   **R users**: See `varunayanR <https://varunayanr.saketlab.org>`_, the R companion package.
+
+Data Sources
+------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 50 30
+
+   * - Source
+     - Coverage
+     - Access
+   * - **ERA5**
+     - Global reanalysis, 0.25° grid, 1940-present
+     - CDS API (bbox, point, GeoJSON)
+   * - **IMD**
+     - India gridded rainfall (0.25°) and temperature (1°), 1901-present
+     - Direct download
+   * - **HadEX3**
+     - Global ETCCDI climate extremes indices, 1.875° grid
+     - Direct download
+   * - **CRU TS**
+     - Global monthly climate grids (0.5°), 1901-present
+     - Direct download
 
 Quick Start
 -----------
 
-Installation
-~~~~~~~~~~~~
-
 .. code-block:: bash
 
    pip install varunayan
 
-Basic Usage
-~~~~~~~~~~~
-
 .. code-block:: python
 
-   from varunayan import era5ify_geojson, era5ify_bbox, era5ify_point
+   import varunayan
 
-   # Download data for a GeoJSON region
-   era5ify_geojson(
-       request_id="my_request",
-       variables=["2m_temperature", "total_precipitation"],
-       start_date="2020-01-01",
-       end_date="2020-01-31",
-       json_file="my_region.geojson"
+   # ERA5 temperature for a bounding box
+   varunayan.era5ify_bbox(
+       request_id="demo",
+       variables=["2m_temperature"],
+       start_date="2023-06-01",
+       end_date="2023-06-30",
+       north=28.7, south=28.5, east=77.3, west=77.0,
    )
 
-   # Download data for a bounding box
-   era5ify_bbox(
-       request_id="bbox_request", 
-       variables=["2m_temperature"],
-       start_date="2020-01-01",
-       end_date="2020-01-02",
-       north=40.0, south=35.0, east=-120.0, west=-125.0
+   # IMD gridded rainfall
+   varunayan.imd_rainfall_bbox(
+       "mumbai", start_year=2020, end_year=2020,
+       north=19.2, south=18.9, east=72.9, west=72.8,
    )
 
-Command Line Interface
-~~~~~~~~~~~~~~~~~~~~~~
+   # HadEX3 climate extremes
+   varunayan.hadex3_bbox("TXx", start_year=2000, end_year=2018,
+       north=35, south=8, east=90, west=68)
 
-.. code-block:: bash
+   # UTCI heat stress index
+   varunayan.utci(temp_c=35.0, rh=60.0, wind_ms=2.0, mrt_c=50.0)
 
-   # Process with GeoJSON file
-   varunayan geojson --request-id "my_request" --variables "2m_temperature,total_precipitation" \
-     --start "2020-01-01" --end "2020-01-31" --geojson "region.geojson"
+CLI
+~~~
 
-   # Process with bounding box
-   varunayan bbox --request-id "bbox_request" --variables "2m_temperature" \
-     --start "2020-01-01" --end "2020-01-02" \
-     --north 40.0 --south 35.0 --east -120.0 --west -125.0
+.. code-block:: bash
 
-   # Process for a single point
-   varunayan point --request-id "point_request" --variables "2m_temperature" \
-     --start "2020-01-01" --end "2020-01-02" --lat 37.7749 --lon -122.4194
+   varunayan bbox --request-id demo --variables 2m_temperature \
+     --start 2023-06-01 --end 2023-06-30 \
+     --north 28.7 --south 28.5 --east 77.3 --west 77.0
 
 .. toctree::
    :maxdepth: 2
@@ -94,9 +95,7 @@ Command Line Interface
    contributing
 
 Jupyter Notebooks
-==================
-
-Interactive notebooks with hands-on examples:
+=================
 
 .. toctree::
    :maxdepth: 1
@@ -134,4 +133,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "varunayan"
-version = "0.2.0"
+version = "0.3.0"
 description = "Analysis-ready climate data downloader and processor for custom regions"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -80,7 +80,9 @@ docs = [
 
     # Enhanced search and navigation
     "sphinx-tabs>=3.0.0",
-    
+    "sphinxext-opengraph>=0.9.0",
+    "sphinx-sitemap>=2.5.0",
+
     # Documentation testing and validation
     "linkify-it-py>=2.0",
     "markdown-it-py>=2.0",
@@ -108,6 +110,8 @@ docs-build = [
     "sphinx-design>=0.3.0",
     "sphinx-togglebutton>=0.3.0",
     "sphinx-tabs>=3.0.0",
+    "sphinxext-opengraph>=0.9.0",
+    "sphinx-sitemap>=2.5.0",
     "linkify-it-py>=2.0",
     "markdown-it-py>=2.0",
     "mdit-py-plugins>=0.3.0",
@@ -237,6 +241,10 @@ module = [
 ]
 ignore_missing_imports = true
 
+[[tool.mypy.overrides]]
+module = ["numpy", "numpy.*"]
+follow_imports = "skip"
+
 [tool.flake8]
 max-line-length = 120
 extend-ignore = ["E203", "W503", "E501"]