Metadata-Version: 2.4
Name: irradpy2
Version: 1.1.0
Summary: Multi-source solar irradiance data acquisition, modeling, separation, and forecasting toolkit.
License-Expression: MIT
Keywords: solar irradiance,meteorological data,data acquisition,clear-sky modeling,clear-sky detection,irradiance separation,solar forecasting
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: requests
Requires-Dist: pytz
Requires-Dist: scikit-learn
Requires-Dist: torch
Dynamic: license-file

# irradpy2

`irradpy2` is a Python package for solar irradiance data acquisition and
analysis, covering clear-sky modeling and detection, irradiance separation,
GHI forecasting, and evaluation.

## Modules

| Module | Description |
|---|---|
| `getirrad` | Ground observations from BSRN, MIDC, SOLRAD, SRML, and SURFRAD |
| `getgridded` | Point and area data from MERRA-2, ERA5, and CAMS |
| `clear_sky` | 62 clear-sky irradiance models |
| `csd` | 23 clear-sky detection methods |
| `separation` | 7 irradiance separation models |
| `forecast` | Persistence, ARIMA, RNN, LSTM, and Informer forecasting |
| `tool.py` | Data preparation, solar geometry, evaluation metrics, and plotting |

## Installation

Python 3.10 or newer is required.

```bash
pip install irradpy2
```

## Examples

Three examples in `irradpy2/example/` demonstrate end-to-end workflows
from data download and preparation to analysis and visualization.

| Example | Workflow | Modules covered |
|---|---|---|
| `ex_download_basic.py` | Download observations, preprocess and inspect the data, and plot irradiance | `getirrad`, `tool` |
| `ex_clearsky_csd.py` | Download and prepare data, calculate clear-sky irradiance, detect clear-sky periods, and visualize results | `getirrad`, `clear_sky`, `csd`, `tool` |
| `ex_separation_forecast.py` | Download and prepare data, estimate DNI and DHI, forecast GHI, and evaluate and visualize results | `getirrad`, `separation`, `forecast`, `tool` |

Run the examples from the project root:

```bash
python irradpy2/example/ex_download_basic.py
python irradpy2/example/ex_clearsky_csd.py
python irradpy2/example/ex_separation_forecast.py
```

## Function documentation

Model descriptions, references, and parameter information are provided
in the source files. Function docstrings can also be viewed with
Python's `help()`:

```python
from irradpy2.separation import engerer2

help(engerer2)
```
