Report

class pysolorie.report.ReportGenerator[source]

A class to generate reports for the optimal orientation of solar panels and the total direct irradiation.

generate_optimal_orientation_csv_report(path: Path, irradiation_calculator: IrradiationCalculator, from_day: int, to_day: int) → None[source]

This method generates a report of optimal solar panel orientation in CSV format. It uses the _calculate_optimal_orientation_and_irradiation method to get the data.

Parameters:

path (Path) – A Path object that points to the CSV file where the report will be written.
irradiation_calculator (pysolorie.IrradiationCalculator) – An instance of the IrradiationCalculator class.
from_day (int) – The starting day of the report.
to_day (int) – The ending day of the report.

generate_optimal_orientation_json_report(path: Path, irradiation_calculator: IrradiationCalculator, from_day: int, to_day: int) → None[source]

This method generates a report of optimal solar panel orientation in JSON format. It uses the _calculate_optimal_orientation_and_irradiation method to get the data.

Parameters:

path (Path) – A Path object that points to the JSON file where the report will be written.
irradiation_calculator (pysolorie.IrradiationCalculator) – An instance of the IrradiationCalculator class.
from_day (int) – The starting day of the report.
to_day (int) – The ending day of the report.

generate_optimal_orientation_xml_report(path: Path, irradiation_calculator: IrradiationCalculator, from_day: int, to_day: int) → None[source]

This method generates a report of optimal solar panel orientation in XML format. It uses the _calculate_optimal_orientation_and_irradiation method to get the data.

Parameters:

path (Path) – A Path object that points to the XML file where the report will be written.
irradiation_calculator (pysolorie.IrradiationCalculator) – An instance of the IrradiationCalculator class.
from_day (int) – The starting day of the report.
to_day (int) – The ending day of the report.