voxcity.simulator.solar.integration
===================================

.. py:module:: voxcity.simulator.solar.integration

.. autoapi-nested-parse::

   Stage 4: High-level workflows & I/O.



Functions
---------

.. autoapisummary::

   voxcity.simulator.solar.integration.get_global_solar_irradiance_using_epw
   voxcity.simulator.solar.integration.get_building_global_solar_irradiance_using_epw
   voxcity.simulator.solar.integration.save_irradiance_mesh
   voxcity.simulator.solar.integration.load_irradiance_mesh


Module Contents
---------------

.. py:function:: get_global_solar_irradiance_using_epw(voxcity: voxcity.models.VoxCity, calc_type: str = 'instantaneous', direct_normal_irradiance_scaling: float = 1.0, diffuse_irradiance_scaling: float = 1.0, **kwargs)

   Compute global irradiance from EPW, either instantaneous or cumulative.


.. py:function:: get_building_global_solar_irradiance_using_epw(*args, **kwargs)

   Compute building-surface irradiance using EPW (instantaneous or cumulative).


.. py:function:: save_irradiance_mesh(irradiance_mesh, output_file_path)

   Persist irradiance mesh to pickle file.


.. py:function:: load_irradiance_mesh(input_file_path)

   Load irradiance mesh from pickle file.