refactor: Split up report and sidebar modules into individual components

Author: markusdlugi

src/solarbatteryield/report.py

@@ -0,0 +1,17 @@
+"""
+Report components for PV analysis visualization.
+
+This package provides modular report rendering with separate components for:
+- Tables (scenario overview, incremental analysis, summary)
+- Charts (monthly energy balance, SoC comparison, longterm PV vs ETF)
+- Header and footer sections
+"""
+from solarbatteryield.report.core import Report, render_report
+from solarbatteryield.report.landing import render_landing_page
+
+__all__ = [
+    "Report",
+    "render_report",
+    "render_landing_page",
+]
+

src/solarbatteryield/report/__init__.py

@@ -0,0 +1,33 @@
+"""
+Altair chart configuration helpers.
+
+Provides shared configuration for German locale and consistent styling
+across all charts in the report.
+"""
+from __future__ import annotations
+
+from typing import Any
+
+# German locale configuration for Altair charts
+GERMAN_LOCALE: dict[str, Any] = {
+    "number": {
+        "decimal": ",",
+        "thousands": ".",
+        "grouping": [3],
+        "currency": ["", " €"],
+    }
+}
+
+
+def configure_german_locale(chart):
+    """
+    Apply German locale configuration to an Altair chart.
+    
+    Args:
+        chart: Altair chart object
+        
+    Returns:
+        Chart with German locale configuration applied
+    """
+    return chart.configure(locale=GERMAN_LOCALE)
+

src/solarbatteryield/report/chart_config.py

@@ -0,0 +1,108 @@
+"""
+Report context providing shared data for all report components.
+
+The ReportContext encapsulates all configuration and results needed by report
+components, avoiding the need to pass many parameters to each component.
+"""
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+import streamlit as st
+
+if TYPE_CHECKING:
+    from solarbatteryield.models import SimulationConfig, AnalysisResult, ScenarioResult
+
+
+def get_short_place_name() -> str | None:
+    """
+    Get a short, readable place name from session state.
+
+    The location name is stored in session state by the sidebar,
+    either from geocoding (forward lookup) or reverse geocoding.
+
+    Returns:
+        Short place name like "München, Bayern" or None if not available.
+    """
+    return st.session_state.get("_location_display_name")
+
+
+@dataclass
+class ReportContext:
+    """
+    Shared context for all report components.
+    
+    Encapsulates configuration and results, providing convenient accessors
+    for commonly used values.
+    """
+    config: SimulationConfig
+    results: AnalysisResult
+
+    # ─── Convenience properties ─────────────────────────────────────────────────
+
+    @property
+    def e_price(self) -> float:
+        """Electricity price in EUR/kWh."""
+        return self.config.economics.e_price
+
+    @property
+    def e_inc(self) -> float:
+        """Annual electricity price increase (decimal)."""
+        return self.config.economics.e_inc
+
+    @property
+    def etf_ret(self) -> float:
+        """Annual ETF return (decimal)."""
+        return self.config.economics.etf_ret
+
+    @property
+    def feed_in_tariff(self) -> float:
+        """Feed-in tariff in EUR/kWh."""
+        return self.config.feed_in_tariff_eur
+
+    @property
+    def analysis_years(self) -> int:
+        """Analysis horizon in years."""
+        return self.config.economics.analysis_years
+
+    @property
+    def reinvest_savings(self) -> bool:
+        """Whether to reinvest savings with ETF return."""
+        return self.config.economics.reinvest_savings
+
+    @property
+    def total_consumption(self) -> float:
+        """Total annual consumption in kWh."""
+        return self.results.total_consumption
+
+    @property
+    def scenarios(self) -> list[ScenarioResult]:
+        """List of scenario results."""
+        return self.results.scenarios
+
+    @property
+    def pv_generation_total(self) -> float:
+        """Total PV generation in kWh/year."""
+        return self.results.pv_generation_total
+
+    @property
+    def lat(self) -> float | None:
+        """Latitude of location."""
+        return self.config.lat
+
+    @property
+    def lon(self) -> float | None:
+        """Longitude of location."""
+        return self.config.lon
+
+    @property
+    def data_year(self) -> int:
+        """PVGIS data year."""
+        return self.config.pv_system.data_year
+
+    @property
+    def total_peak_kwp(self) -> float:
+        """Total PV peak power in kWp."""
+        return self.config.total_peak_kwp
+

src/solarbatteryield/report/context.py

@@ -0,0 +1,65 @@
+"""
+Core Report class that orchestrates all report components.
+"""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from solarbatteryield.report.context import ReportContext
+from solarbatteryield.report.header import render_header
+from solarbatteryield.report.tables import (
+    render_scenario_overview,
+    render_incremental_analysis,
+    render_scenario_details,
+    render_summary,
+)
+from solarbatteryield.report.monthly_chart import render_monthly_energy_balance
+from solarbatteryield.report.soc_chart import render_weekly_soc_comparison
+from solarbatteryield.report.longterm_chart import render_longterm_comparison
+from solarbatteryield.report.footer import render_share_button
+
+if TYPE_CHECKING:
+    from solarbatteryield.models import SimulationConfig, AnalysisResult
+
+
+class Report:
+    """
+    Renders the complete PV analysis report.
+    
+    Orchestrates all report components in the correct order,
+    using a shared ReportContext for configuration and results.
+    """
+
+    def __init__(self, config: SimulationConfig, results: AnalysisResult) -> None:
+        """
+        Initialize the report with configuration and results.
+        
+        Args:
+            config: Simulation configuration
+            results: Analysis results with all scenarios
+        """
+        self.ctx = ReportContext(config=config, results=results)
+
+    def render(self) -> None:
+        """Render the complete analysis report."""
+        render_header(self.ctx)
+        render_scenario_overview(self.ctx)
+        render_monthly_energy_balance(self.ctx)
+        render_weekly_soc_comparison(self.ctx)
+        render_incremental_analysis(self.ctx)
+        render_longterm_comparison(self.ctx)
+        render_scenario_details(self.ctx)
+        render_summary(self.ctx)
+        render_share_button()
+
+
+def render_report(config: SimulationConfig, results: AnalysisResult) -> None:
+    """
+    Convenience function to create and render a report.
+    
+    Args:
+        config: Simulation configuration
+        results: Analysis results with all scenarios
+    """
+    Report(config, results).render()
+

src/solarbatteryield/report/core.py

@@ -0,0 +1,44 @@
+"""
+Report footer components: share button and data attribution.
+"""
+from __future__ import annotations
+
+import streamlit as st
+
+from solarbatteryield.state import encode_config
+
+
+def render_share_button() -> None:
+    """
+    Render the configuration sharing button.
+    
+    Creates a shareable URL with all current configuration parameters
+    encoded as a compressed base64 string.
+    """
+    st.divider()
+    if st.button("🔗 Link mit aktueller Konfiguration erstellen"):
+        try:
+            encoded = encode_config()
+            base_url = st.context.headers.get("Origin", "")
+            share_url = f"{base_url}/?cfg={encoded}"
+            st.code(share_url, language=None)
+            st.caption("Link kopieren und teilen – alle Parameter sind im Link gespeichert.")
+        except Exception as exc:
+            st.error(f"Fehler beim Erstellen des Links: {exc}")
+
+    render_data_attribution()
+
+
+def render_data_attribution() -> None:
+    """
+    Render data source attribution footer.
+    
+    Credits PVGIS and OpenStreetMap as data sources.
+    """
+    st.divider()
+    st.caption(
+        "📊 Datenquellen: PV-Daten © [PVGIS](https://re.jrc.ec.europa.eu/pvg_tools/en/) (European Commission) · "
+        "Geocoding © [OpenStreetMap](https://www.openstreetmap.org/copyright) contributors, "
+        "[ODbL](https://opendatacommons.org/licenses/odbl/)"
+    )
+

src/solarbatteryield/report/footer.py

@@ -0,0 +1,38 @@
+"""
+Report header section with key metrics.
+"""
+from __future__ import annotations
+
+import streamlit as st
+
+from solarbatteryield.report.context import ReportContext, get_short_place_name
+from solarbatteryield.utils import de
+
+
+def render_header(ctx: ReportContext) -> None:
+    """
+    Render the main header section with key metrics.
+    
+    Displays:
+    - Title with location info
+    - Key metrics: consumption, cost, PV power, PV generation
+    
+    Args:
+        ctx: Report context with config and results
+    """
+    st.title("☀️ SolarBatterYield - PV-Analyse mit Speichervergleich")
+    
+    place_name = get_short_place_name()
+    if place_name:
+        location_str = f"{place_name} ({ctx.lat}°N / {ctx.lon}°E)"
+    else:
+        location_str = f"{ctx.lat}°N / {ctx.lon}°E"
+    
+    st.caption(f"PVGIS-Stundenwerte {ctx.data_year}  ·  Standort {location_str}")
+
+    col1, col2, col3, col4 = st.columns(4)
+    col1.metric("Gesamtverbrauch", f"{de(ctx.total_consumption)} kWh/a")
+    col2.metric("Stromkosten ohne PV", f"{de(ctx.total_consumption * ctx.e_price)} €/a")
+    col3.metric("PV-Leistung", f"{de(ctx.total_peak_kwp, 1)} kWp")
+    col4.metric("PV-Erzeugung", f"{de(ctx.pv_generation_total)} kWh/a")
+

src/solarbatteryield/report/header.py

@@ -0,0 +1,44 @@
+"""
+Landing page component.
+"""
+from __future__ import annotations
+
+import streamlit as st
+
+from solarbatteryield.report.footer import render_data_attribution
+
+
+def render_landing_page(missing: list[str]) -> None:
+    """
+    Render the application landing page.
+
+    Displays a welcome message, lists any missing configuration parameters,
+    and describes the default system that will be used once configured.
+
+    Args:
+        missing: List of missing configuration items with descriptions
+    """
+    st.title("☀️ SolarBatterYield - PV-Analyse mit Speichervergleich")
+    st.markdown(
+        "Interaktive App zur Simulation und Wirtschaftlichkeitsanalyse von "
+        "Photovoltaik-Anlagen mit Batteriespeicher – optimiert für **Balkonkraftwerke**."
+    )
+    missing_list = "\n".join(f"- {m}" for m in missing)
+    st.info(
+        "Bitte konfiguriere mindestens folgende Parameter in der **Seitenleiste** (⚙️), "
+        f"um die Analyse zu starten:\n\n{missing_list}"
+    )
+
+    st.markdown(
+        "Nach Hinzufügen der erforderlichen Parameter wird ein Report mit Standardwerten generiert. "
+        "Er verwendet ein beispielhaftes System, bestehend aus:"
+    )
+    st.markdown("- ☀️ PV-Modulen mit 2kWp Leistung in Südausrichtung")
+    st.markdown("- 🔋️ drei unterschiedlichen Speicherkonfigurationen mit bis zu 6kWh")
+    st.markdown(
+        "Du kannst diese beliebig erweitern, ändern, löschen oder zusätzliche Einstellungen anpassen - "
+        "der Report wird automatisch aktualisiert."
+    )
+
+    render_data_attribution()
+