Skip to content

Commit

Permalink
Update Documentation with JSON and XML Report Instructions
Browse files Browse the repository at this point in the history
Added documentation for the `generate_optimal_orientation_json_report` method in getting_started.rst.
Introduced documentation for the `generate_optimal_orientation_xml_report` method.
  • Loading branch information
aaghamohammadi committed Dec 20, 2023
1 parent 3a8383f commit 5f436b1
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,49 @@ the optimal orientation for a range of days.
The CSV file will be saved to the specified path.

Generating a JSON Report
------------------------

The ``generate_optimal_orientation_json_report`` method generates a JSON report of
the optimal orientation for a range of days.

.. code-block:: python
from pysolorie import ReportGenerator, IrradiationCalculator
from pathlib import Path
# Create a report generator and an irradiation calculator
report_generator = ReportGenerator()
irradiation_calculator = IrradiationCalculator("MIDLATITUDE SUMMER", 1200, 35.6892)
# Generate a JSON report for days 60 to 70
report_generator.generate_optimal_orientation_json_report(Path('results.json'), irradiation_calculator, 60, 70)
The JSON file will be saved to the specified path.


Generating an XML Report
------------------------

The ``generate_optimal_orientation_xml_report`` method generates an XML report of
the optimal orientation for a range of days.

.. code-block:: python
from pysolorie import ReportGenerator, IrradiationCalculator
from pathlib import Path
# Create a report generator and an irradiation calculator
report_generator = ReportGenerator()
irradiation_calculator = IrradiationCalculator("MIDLATITUDE SUMMER", 1200, 35.6892)
# Generate an XML report for days 60 to 70
report_generator.generate_optimal_orientation_xml_report(Path('results.xml'), irradiation_calculator, 60, 70)
The XML file will be saved to the specified path.




Plotting the Optimal Orientation
--------------------------------
Expand Down

0 comments on commit 5f436b1

Please sign in to comment.