Metadata-Version: 2.4
Name: solarex
Version: 0.1.0
Summary: SolareX - Solar Resource eXchange: solar PV resource assessment, MCDA, and site analysis
Author: SolareX Development Team
License: MIT
Project-URL: Homepage, https://github.com/solarex-dev/solarex
Project-URL: Repository, https://github.com/solarex-dev/solarex
Keywords: solar energy,solar PV,renewable energy,irradiance,capacity factor,MCDA,bifacial,shading
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.22
Requires-Dist: scipy>=1.8
Requires-Dist: requests>=2.28
Provides-Extra: era5
Requires-Dist: atlite>=0.2.10; extra == "era5"
Requires-Dist: xarray>=0.19; extra == "era5"
Requires-Dist: dask>=2022.1; extra == "era5"
Provides-Extra: pvlib
Requires-Dist: pvlib>=0.10; extra == "pvlib"
Provides-Extra: viz
Requires-Dist: matplotlib>=3.4; extra == "viz"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.1; extra == "dev"
Requires-Dist: build>=1.0; extra == "dev"
Requires-Dist: twine>=4.0; extra == "dev"
Provides-Extra: all
Requires-Dist: atlite>=0.2.10; extra == "all"
Requires-Dist: xarray>=0.19; extra == "all"
Requires-Dist: dask>=2022.1; extra == "all"
Requires-Dist: pvlib>=0.10; extra == "all"
Requires-Dist: matplotlib>=3.4; extra == "all"
Requires-Dist: pytest>=7.0; extra == "all"
Requires-Dist: pytest-cov>=4.0; extra == "all"
Dynamic: license-file

# SolareX - Solar Resource eXchange

[![Tests](https://github.com/msotocalvo/solarex/actions/workflows/tests.yml/badge.svg)](https://github.com/msotocalvo/solarex/actions/workflows/tests.yml)
[![DOI](https://zenodo.org/badge/1175040710.svg)](https://doi.org/10.5281/zenodo.18898422)

A Python library for solar PV resource assessment, irradiance analysis,
temperature modeling, shading/bifacial analysis, MCDA site scoring, and
capacity factor computation.

## Installation

```bash
pip install solarex
```

With optional dependencies:

```bash
pip install solarex[era5]    # ERA5 via atlite
pip install solarex[pvlib]   # CEC module database
pip install solarex[all]     # Everything
```

## Quick Start

```python
from solarex import (
    compute_peak_sun_hours,
    compute_gcr_shading_loss,
    compute_bifacial_gain,
    compute_pv_financials,
    SolarFinancialInputs,
)

# Financial analysis
inputs = SolarFinancialInputs(capacity_mw=50, capacity_factor=0.22)
result = compute_pv_financials(inputs)
print(f"LCOE: ${result.lcoe:.1f}/MWh, NPV: ${result.npv:,.0f}")

# Shading analysis
loss = compute_gcr_shading_loss(latitude=30, tilt=25, gcr=0.4)
print(f"Shading loss: {loss:.1%}")

# Bifacial gain
gain = compute_bifacial_gain(albedo=0.25, gcr=0.4, module_height=2.0, tilt=25)
print(f"Bifacial gain: {gain:.1%}")
```

## Modules

- `solarex.core` - Irradiance, temperature, shading, bifacial, capacity factor
- `solarex.data` - Open-Meteo, NASA POWER, ERA5, terrain, LULC, module DB
- `solarex.economics` - Financial analysis and LCOE sensitivity
- `solarex.analysis` - MCDA engine and grid evaluation
- `solarex.regional` - Regional analyzer and zone generation

## License

MIT
