Metadata-Version: 2.4
Name: solarscenarios
Version: 0.1.2
Summary: New Zealand electricity tariff data
Keywords: solar,new-zealand,electricity,tariffs,energy
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Requires-Dist: pyyaml>=6
Requires-Python: >=3.10
Project-URL: Homepage, https://solarscenarios.com
Project-URL: Repository, https://github.com/solarscenarios/solarscenarios
Description-Content-Type: text/markdown

# solarscenarios

Small dataset + loaders for New Zealand electricity tariff scenarios.

## install

```bash
pip install solarscenarios
```

## quick use

```python
from solarscenarios import get_region_to_network, get_network_schedules

region_to_network = get_region_to_network()
schedules = get_network_schedules()

print(region_to_network["08-Hamilton"])
print(schedules["WEL Networks"])
```

## data sources and usage

This repository contains tariff data compiled from publicly available retailer and network pricing pages, including Powershop rates:

- https://www.powershop.co.nz/our-rates/

Important notes:

- The code in this repository is MIT licensed (see LICENSE).
- Tariff values and source material may remain subject to third-party terms, trademarks, and other rights.
- This project is not affiliated with or endorsed by any retailer or network company.
- You are responsible for checking source terms and confirming suitability before commercial or operational use.

## contributing

Contributions are welcome. Please read CONTRIBUTING.md for setup, style, and pull request guidance.

By contributing, you confirm that your changes are your own work or are compatible with the project license and any relevant third-party terms.
