BREOS - Building Renewable Energy Optimization Software
BREOS is a Python library for simulating and optimizing PV + battery energy
systems (weather, PV production, battery aging, economics, emissions, and
multi-objective sizing) behind one stable breos.App facade, with lower-level
modules for building custom study pipelines. The PV modeling is powered by
pvlib python, which supplies the solar
position, irradiance, cell-temperature, and single-diode physics BREOS builds
its production pipeline on.
📖 Full documentation: breos.readthedocs.io
Features
- Weather — TMY from PVGIS/NSRDB and historical data from Open-Meteo, at hourly or 15-minute resolution.
- PV production — pvlib CEC single-diode model, with a small example module catalog to get started.
- Multi-array systems — combine multiple faces/orientations (e.g. an east-west roof) at the DC stage instead of one representative tilt.
- Battery — energy balance with calendar + cycle aging (Naumann 2020, Lam 2025) and field-calibrated LFP parameters.
- Economics — NPV, LCOE, breakeven, and cost projections with configurable tariffs and inflation.
- Monte Carlo — weather-year and demand resampling for NPV, payback, grid-independence, LCOE, and SoH distributions.
- Optimization — multi-objective PV/battery sizing (pymoo NSGA-II), tilt optimization, and sizing sweeps.
- Emissions — CO2 savings and projections.
- Visualization — publication-ready plots for energy balances, degradation, breakeven, and Pareto fronts.
- Bring your own data — every layer accepts custom inputs: PV module parameters, battery degradation coefficients, weather CSVs, load profiles, and cost/tariff/emissions assumptions. The packaged presets are starting points, not fixed defaults.
Installation
pip install breos
Or with uv:
uv add breos # as a project dependency
uvx breos --version # run the CLI without installing
Verify the installation and inspect a complete resolved configuration without creating a file, fetching weather, or running a simulation:
breos run --location porto --n-modules 10 \
--annual-consumption-kwh 4000 --dry-run
The default install is a lean core. Some workflows need optional extras (e.g. optimization, historical weather, plots):
pip install "breos[optimization,weather,plots]"
See the installation guide
for the full list of extras and a source/uv setup.
Quick Start
import breos
app = breos.App({
"location": "porto", # preset or {"latitude": ..., "longitude": ..., "timezone": ...}
"n_modules": 10,
"annual_consumption_kwh": 4000,
"battery_kwh": 5.0, # 0 for no battery
"cost_preset": "residential_pt",
"emissions_country": "PT",
})
app.simulate()
result = app.result()
print(f"Grid independence: {result['grid_independence_pct']:.1f}%")
print(f"Payback: {result['payback_year']} years")
print(f"NPV savings: {result['npv_savings_eur']:,.0f} EUR")
result() returns a plain JSON-serializable dict. The
configuration reference
lists every option, and
interpreting results
documents every output field.
For real studies, bring your own weather/API access where required (NSRDB needs an NREL API key; PVGIS and Open-Meteo do not), licensed load profiles, and your own cost/tariff assumptions. The packaged defaults make the tool runnable, not project-grade.
Command Line
Run a simulation without writing Python:
breos run --location porto --n-modules 10 --annual-consumption-kwh 4000 \
--battery-kwh 5.0 --cost-preset residential-pt --emissions-country pt \
--output result.json
The CLI also drives config files, parameter sweeps, and Monte Carlo studies, and
breos list <category> shows bundled presets (locations, modules, cost presets,
…). See the CLI recipes.
Citation
If you use BREOS in your research, please cite the preprint:
@misc{rodrigues2026breos,
author = {Rodrigues, L. and Delgado, J. M. P. Q. and Mendes, A. and Guimar{\~a}es, A. S.},
title = {A Modular, Open-Source Python Framework for Household PV-Battery Sizing: Validation, Multi-Objective Optimisation, and Uncertainty Analysis},
year = {2026},
doi = {10.2139/ssrn.7032064},
url = {https://papers.ssrn.com/sol3/papers.cfm?abstract_id=7032064},
note = {SSRN preprint}
}
BREOS results that depend on PV production also depend on pvlib. Please cite it alongside BREOS:
@article{anderson2023pvlib,
author = {Anderson, K. and Hansen, C. and Holmgren, W. and Jensen, A. and Mikofski, M. and Driesse, A.},
title = {pvlib python: 2023 project update},
journal = {Journal of Open Source Software},
volume = {8},
number = {92},
pages = {5994},
year = {2023},
doi = {10.21105/joss.05994}
}
pvlib additionally asks that you cite the Zenodo DOI for the specific pvlib version you used.
Acknowledgements
BREOS stands on work done by others:
- pvlib python — the PV modeling foundation: solar position, irradiance transposition, IAM, cell temperature, CEC single-diode evaluation, PVWatts losses, tracking, and inverter helpers. BREOS composes these into a production pipeline with staged losses, degradation, and multi-array handling; the underlying physics is pvlib's.
- BLAST-Lite (NREL) — vendored battery life models.
- demandlib — basis for the bundled example H0 load profiles.
- pymoo — NSGA-II multi-objective optimization.
- PVGIS (EU JRC), NREL NSRDB, and Open-Meteo — weather and solar resource data.
Model choices, defaults, and any errors in how these are combined are BREOS's own, not those of the upstream projects. See ATTRIBUTIONS.md for the full list with licenses and terms.
Contributing
See CONTRIBUTING.md. Feature work happens on branches off
develop and merges via pull request; main tracks stable releases only.
Contact
Usage questions and feature ideas: GitHub Discussions. Bugs: issues. Research collaboration or private enquiries: lrodrigues@fe.up.pt.
License
BSD 3-Clause. See LICENSE.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file breos-0.5.0.tar.gz.
File metadata
- Download URL: breos-0.5.0.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a8374bd9af8b9716916e359b140f992c28e8925d7d86e483bbeeab1216bc4d8
|
|
| MD5 |
059f18af3e8071539c565871fc3e2e62
|
|
| BLAKE2b-256 |
d4f7d84738f04c1b9d5bb700384757269a92e38d47120d4a468b68eeec561e98
|
Provenance
The following attestation bundles were made for breos-0.5.0.tar.gz:
Publisher:
publish.yml on Str4vinci/breos
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
breos-0.5.0.tar.gz -
Subject digest:
4a8374bd9af8b9716916e359b140f992c28e8925d7d86e483bbeeab1216bc4d8 - Sigstore transparency entry: 2345333726
- Sigstore integration time:
-
Permalink:
Str4vinci/breos@134c99e88bbf5a6496d66eb8be42c6ac96366521 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/Str4vinci
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@134c99e88bbf5a6496d66eb8be42c6ac96366521 -
Trigger Event:
push
-
Statement type:
File details
Details for the file breos-0.5.0-py3-none-any.whl.
File metadata
- Download URL: breos-0.5.0-py3-none-any.whl
- Upload date:
- Size: 769.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b0f8538130ba5079b4181f505897382c1ba82a15776f3a32d9df52bb23945d7
|
|
| MD5 |
e6b1625503a18126d3436f7bd58d350c
|
|
| BLAKE2b-256 |
f461033cfae48cc6c51c3fcd84562d678461172cfe80b3073279d8d7fcbab5ee
|
Provenance
The following attestation bundles were made for breos-0.5.0-py3-none-any.whl:
Publisher:
publish.yml on Str4vinci/breos
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
breos-0.5.0-py3-none-any.whl -
Subject digest:
4b0f8538130ba5079b4181f505897382c1ba82a15776f3a32d9df52bb23945d7 - Sigstore transparency entry: 2345333760
- Sigstore integration time:
-
Permalink:
Str4vinci/breos@134c99e88bbf5a6496d66eb8be42c6ac96366521 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/Str4vinci
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@134c99e88bbf5a6496d66eb8be42c6ac96366521 -
Trigger Event:
push
-
Statement type: