API reference#
BREOS’s API reference is organized by domain area rather than by Python
module — the PV reference pulls names from breos.solar,
breos.pv_modules, and breos.inverter, since all three describe the same
part of a system.
The App facade is the recommended entry point. The
top-level breos.__all__ list is intentionally narrower than the full
reference: it marks the stable release surface for from breos import *.
The pages below cover lower-level module APIs you reach for when composing a
custom pipeline. Import those lower-level names from their modules, for example
from breos.solar import calculate_pv_production_dc.
Domain areas#
TMY and historical data, file I/O, resampling, clear-sky scaling.
DC and AC production, multi-array layouts, module catalogue, inverter sizing.
Standard residential and commercial profiles, scaling, alignment.
Per-timestep PV, load, battery, and grid energy flows.
Configuration, indoor temperature model, calendar and cycle degradation.
Cost parameters, NPV / LCOE / payback projections, emissions.
Tilt search, battery sizing, ZEB sizing, and NSGA-II multi-objective sizing.
Publication-ready figures for production, costs, degradation, and Pareto fronts.
Other surfaces#
Appendix documents additional module APIs — constants, I/O helpers, utilities, and research-validation modules that remain importable but are not part of the narrow top-level release surface.