Metadata-Version: 2.4
Name: climaid
Version: 0.1.2
Summary: Climate Change impact using AI on Diseases (ClimAID) Toolkit for Climate-Driven Disease Modelling
Author-email: Avik Kumar Sam <avik.sam@iitb.ac.in>
License: MIT
Project-URL: Homepage, https://github.com/sam-as/ClimAID
Project-URL: Repository, https://github.com/sam-as/ClimAID
Project-URL: Documentation, https://sam-as.github.io/ClimAID/
Keywords: climate,epidemiology,disease modelling,dengue,malaria,water-borne diseases,cmip6,projections,south asia,global,climate-health
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pandas>=2.3
Requires-Dist: numpy>=1.26
Requires-Dist: geopandas>=0.14
Requires-Dist: matplotlib>=3.7
Requires-Dist: scikit-learn>=1.6
Requires-Dist: xarray>=2023.11
Requires-Dist: regionmask>=0.13
Requires-Dist: requests>=2.32
Requires-Dist: joblib>=1.3
Requires-Dist: optuna>=4.0.0
Requires-Dist: xgboost>=2.0.0
Requires-Dist: plotly>=6.3.0
Requires-Dist: Markdown>=3.4.1
Requires-Dist: typer>=0.24.1
Requires-Dist: uvicorn>=0.41.0
Requires-Dist: fastapi>=0.135.1
Requires-Dist: fastparquet>=2024.5.0
Requires-Dist: python-multipart>=0.0.22
Requires-Dist: seaborn>=0.12.2
Requires-Dist: openpyxl>=3.1.0
Provides-Extra: full
Requires-Dist: ollama>=0.1.0; extra == "full"

# ClimAID - **Climate Change impact using AI on Diseases**

ClimAID is an integrated toolkit for modeling, forecasting, and projecting climate-sensitive diseases such as dengue and malaria using machine learning and climate model ensembles.

* ClimAID has inbuilt climate data for South Asian countries, namely India, Nepal, Bhutan, Sri Lanka, Myanmar, Afghanistan, Pakistan and Bangladesh. 

* ClimAID support data from other countries through the global mode on the browser interface. 

---

## What you can do

* Analyze historical disease patterns
* Integrate climate variables (temperature, rainfall, humidity)
* Automatically detect optimal lag effects using AutoML
* Train hybrid ML models
* Generate CMIP6-based future projections
* Identify outbreak risk under climate change scenarios
* Generate automated policy reports using the integrated C-DSI or local LLM models. 

---

## Quick Example using Codes

```python
from climaid.climaid_model import DiseaseModel

dm = DiseaseModel(
    district='IND_Mumbai_MAHARASHTRA',
    disease_file="dengue_data.xlsx",
    disease_name="Dengue"
)

dm.optimize_lags()
dm.train_final_model()
```

---

## Workflow

ClimAID has two interfaces, 

* **ClimAID Browser Interface** (For both South Asian + Global countries)
    
    For initialisation through terminal, use
    ```text
        climaid browse
    ```

* **ClimAID Wizard Interface** (For South Asian countries)
    
    For initialisation through terminal, use
    ```text
        climaid wizard
    ```
---

## Documentation

The full documentation is available here: [https://sam-as.github.io/ClimAID/](https://sam-as.github.io/ClimAID/) 

---

## Designed for

* Epidemiologists
* Climate scientists
* Public health analysts
* Data scientists

---

## Dependencies & License

### Dependencies

* Core Requirements

    ```bash
    pandas  
    numpy  
    geopandas  
    matplotlib  
    scikit-learn  
    xarray  
    regionmask  
    plotly  
    xgboost  
    optuna
    ```  

* Additional Utilities

    These packages support extended functionality and will be 
    auto-installed. 

    ```bash
    requests
    joblib
    fastapi
    uvicorn
    typer
    markdown
    fastparquet
    python-multipart
    seaborn
    openpyxl
    ```

* Optional (LLM Support)

    To enable local LLM-based report generation:

    ```bash
    pip install climaid[full]
    ```

    Includes:
    ```bash
    ollama 
    ``` 

---

### License

Designed by **Avik Kumar Sam** & **Harish C. Phuleria** as an open-access software. 

* MIT License Summary
    - Free to use, modify, and distribute  
    - Suitable for research and commercial use  
    - No warranty is provided  
    - Attribution is required  

* Full License Text
    - See the complete license here: [https://github.com/sam-as/ClimAID/blob/main/LICENSE](https://github.com/sam-as/ClimAID/blob/main/LICENSE)

---
