.. imdlib documentation master file, created by
   sphinx-quickstart on Wed Dec 30 16:00:48 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

IMDLIB - a Python library for IMD gridded data
==============================================

IMDLIB is a python package to download and handle binary gridded data from the India Meteorological
Department (IMD). For more information about the IMD datasets, the link of 
`IMD Pune`_ may be referred. It heavily employs the `xarray`_ for processing the datasets.

.. _IMD Pune: https://imdpune.gov.in/lrfindex.php
.. _xarray: http://xarray.pydata.org/en/stable/

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   Description

.. toctree::
   :maxdepth: 1
   :caption: Usage

   Usage

.. toctree::
   :maxdepth: 1
   :caption: Reference
   
   faq
   climate-indices
   changelog
   cf-conventions
   publication
   api

Citation
--------

If you use IMDLIB in an academic publication, please cite:

Nandi, S., Patel, P., and Swain, S. (2024). IMDLIB: An open-source library
for retrieval, processing and spatiotemporal exploratory assessments of
gridded meteorological observation datasets over India.
*Environmental Modelling and Software*, 171, 105869.
`DOI <https://doi.org/10.1016/j.envsoft.2023.105869>`__

About
-----

:License:
    MIT License

:Status:
    .. image:: https://badge.fury.io/py/imdlib.svg
        :target: https://badge.fury.io/py/imdlib
    .. image:: https://anaconda.org/conda-forge/imdlib/badges/version.svg
        :target: https://anaconda.org/conda-forge/imdlib

:Documentation:
    .. image:: https://readthedocs.org/projects/imdlib/badge/?version=stable
        :target: http://imdlib.readthedocs.io/?badge=stable

:Contact:
    * `Saswata Nandi <https://saswatanandi.github.io/>`__
    * `Pratiman Patel <https://pratiman-91.github.io/>`__
    * `Sabyasachi Swain <https://scholar.google.co.in/citations?user=5l3ePBUAAAAJ&hl=en&oi=ao/>`__

.. meta::
   :description: IMDLIB is a python package library to download IMD gridded data
   :keywords: imdlib, IMDLIB, imd, IMD, python, India, gridded rainfall, gridded temperature