diff --git a/.gitignore b/.gitignore index 72b65484d3..e124a08fdb 100644 --- a/.gitignore +++ b/.gitignore @@ -40,6 +40,7 @@ pvlib/spa_c_files/spa_tester.c # generated documentation docs/sphinx/source/reference/generated +docs/sphinx/source/reference/*/generated docs/sphinx/source/savefig docs/sphinx/source/gallery diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output.rst b/docs/sphinx/source/reference/effects_on_pv_system_output.rst deleted file mode 100644 index 6144df2802..0000000000 --- a/docs/sphinx/source/reference/effects_on_pv_system_output.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. currentmodule:: pvlib - -Effects on PV System Output -=========================== - -Loss models ------------ - -.. autosummary:: - :toctree: generated/ - - pvsystem.combine_loss_factors - pvsystem.dc_ohms_from_percent - -Snow ----- - -.. autosummary:: - :toctree: generated/ - - snow.coverage_nrel - snow.fully_covered_nrel - snow.dc_loss_nrel - snow.loss_townsend - -Soiling -------- - -.. autosummary:: - :toctree: generated/ - - soiling.hsu - soiling.kimber - -Shading -------- - -.. autosummary:: - :toctree: generated/ - - shading.masking_angle - shading.masking_angle_passias - shading.sky_diffuse_passias - -Spectrum --------- - -.. autosummary:: - :toctree: generated/ - - spectrum.spectrl2 - spectrum.get_example_spectral_response - spectrum.get_am15g - spectrum.calc_spectral_mismatch_field diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/index.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/index.rst new file mode 100644 index 0000000000..cb046de7db --- /dev/null +++ b/docs/sphinx/source/reference/effects_on_pv_system_output/index.rst @@ -0,0 +1,13 @@ +.. currentmodule:: pvlib + +Effects on PV System Output +=========================== + +.. toctree:: + :maxdepth: 2 + + loss-models + snow + soiling + shading + spectrum diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/loss-models.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/loss-models.rst new file mode 100644 index 0000000000..6897f12283 --- /dev/null +++ b/docs/sphinx/source/reference/effects_on_pv_system_output/loss-models.rst @@ -0,0 +1,10 @@ +.. currentmodule:: pvlib + +Loss models +----------- + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.combine_loss_factors + pvsystem.dc_ohms_from_percent diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/shading.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/shading.rst new file mode 100644 index 0000000000..a68dd94b2a --- /dev/null +++ b/docs/sphinx/source/reference/effects_on_pv_system_output/shading.rst @@ -0,0 +1,11 @@ +.. currentmodule:: pvlib + +Shading +------- + +.. autosummary:: + :toctree: ../generated/ + + shading.masking_angle + shading.masking_angle_passias + shading.sky_diffuse_passias \ No newline at end of file diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst new file mode 100644 index 0000000000..006cb284b2 --- /dev/null +++ b/docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst @@ -0,0 +1,12 @@ +.. currentmodule:: pvlib + +Snow +---- + +.. autosummary:: + :toctree: ../generated/ + + snow.coverage_nrel + snow.fully_covered_nrel + snow.dc_loss_nrel + snow.loss_townsend diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/soiling.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/soiling.rst new file mode 100644 index 0000000000..e5afedeafe --- /dev/null +++ b/docs/sphinx/source/reference/effects_on_pv_system_output/soiling.rst @@ -0,0 +1,10 @@ +.. currentmodule:: pvlib + +Soiling +------- + +.. autosummary:: + :toctree: ../generated/ + + soiling.hsu + soiling.kimber diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst new file mode 100644 index 0000000000..b6fe7f4684 --- /dev/null +++ b/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst @@ -0,0 +1,12 @@ +.. currentmodule:: pvlib + +Spectrum +-------- + +.. autosummary:: + :toctree: ../generated/ + + spectrum.spectrl2 + spectrum.get_example_spectral_response + spectrum.get_am15g + spectrum.calc_spectral_mismatch_field diff --git a/docs/sphinx/source/reference/index.rst b/docs/sphinx/source/reference/index.rst index b96ca4114f..1ab6d81969 100644 --- a/docs/sphinx/source/reference/index.rst +++ b/docs/sphinx/source/reference/index.rst @@ -11,9 +11,9 @@ API reference solarposition clearsky airmass_atmospheric - irradiance - pv_modeling - effects_on_pv_system_output + irradiance/index + pv_modeling/index + effects_on_pv_system_output/index tracking iotools forecasting diff --git a/docs/sphinx/source/reference/irradiance.rst b/docs/sphinx/source/reference/irradiance.rst deleted file mode 100644 index ad3da96eab..0000000000 --- a/docs/sphinx/source/reference/irradiance.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. currentmodule:: pvlib - -Irradiance -========== - -Methods for irradiance calculations ------------------------------------ - -.. autosummary:: - :toctree: generated/ - - pvsystem.PVSystem.get_irradiance - pvsystem.PVSystem.get_aoi - pvsystem.PVSystem.get_iam - tracking.SingleAxisTracker.get_irradiance - -Decomposing and combining irradiance ------------------------------------- - -.. autosummary:: - :toctree: generated/ - - irradiance.get_extra_radiation - irradiance.aoi - irradiance.aoi_projection - irradiance.poa_horizontal_ratio - irradiance.beam_component - irradiance.poa_components - irradiance.get_ground_diffuse - irradiance.dni - irradiance.complete_irradiance - -Transposition models --------------------- - -.. autosummary:: - :toctree: generated/ - - irradiance.get_total_irradiance - irradiance.get_sky_diffuse - irradiance.isotropic - irradiance.perez - irradiance.haydavies - irradiance.klucher - irradiance.reindl - irradiance.king - -.. _dniestmodels: - -DNI estimation models ---------------------- - -.. autosummary:: - :toctree: generated/ - - irradiance.disc - irradiance.dirint - irradiance.dirindex - irradiance.erbs - irradiance.campbell_norman - irradiance.gti_dirint - -Clearness index models ----------------------- - -.. autosummary:: - :toctree: generated/ - - irradiance.clearness_index - irradiance.clearness_index_zenith_independent - irradiance.clearsky_index diff --git a/docs/sphinx/source/reference/irradiance/class-methods.rst b/docs/sphinx/source/reference/irradiance/class-methods.rst new file mode 100644 index 0000000000..67c16736dc --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/class-methods.rst @@ -0,0 +1,12 @@ +.. currentmodule:: pvlib + +Methods for irradiance calculations +----------------------------------- + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.PVSystem.get_irradiance + pvsystem.PVSystem.get_aoi + pvsystem.PVSystem.get_iam + tracking.SingleAxisTracker.get_irradiance diff --git a/docs/sphinx/source/reference/irradiance/clearness-index.rst b/docs/sphinx/source/reference/irradiance/clearness-index.rst new file mode 100644 index 0000000000..bfc6d7bf8e --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/clearness-index.rst @@ -0,0 +1,11 @@ +.. currentmodule:: pvlib + +Clearness index models +---------------------- + +.. autosummary:: + :toctree: ../generated/ + + irradiance.clearness_index + irradiance.clearness_index_zenith_independent + irradiance.clearsky_index diff --git a/docs/sphinx/source/reference/irradiance/components.rst b/docs/sphinx/source/reference/irradiance/components.rst new file mode 100644 index 0000000000..b217f9067a --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/components.rst @@ -0,0 +1,17 @@ +.. currentmodule:: pvlib + +Decomposing and combining irradiance +------------------------------------ + +.. autosummary:: + :toctree: ../generated/ + + irradiance.get_extra_radiation + irradiance.aoi + irradiance.aoi_projection + irradiance.poa_horizontal_ratio + irradiance.beam_component + irradiance.poa_components + irradiance.get_ground_diffuse + irradiance.dni + irradiance.complete_irradiance diff --git a/docs/sphinx/source/reference/irradiance/decomposition.rst b/docs/sphinx/source/reference/irradiance/decomposition.rst new file mode 100644 index 0000000000..2b89a272d7 --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/decomposition.rst @@ -0,0 +1,16 @@ +.. currentmodule:: pvlib + +.. _dniestmodels: + +DNI estimation models +--------------------- + +.. autosummary:: + :toctree: ../generated/ + + irradiance.disc + irradiance.dirint + irradiance.dirindex + irradiance.erbs + irradiance.campbell_norman + irradiance.gti_dirint diff --git a/docs/sphinx/source/reference/irradiance/index.rst b/docs/sphinx/source/reference/irradiance/index.rst new file mode 100644 index 0000000000..2263a2d2c1 --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/index.rst @@ -0,0 +1,13 @@ +.. currentmodule:: pvlib + +Irradiance +========== + +.. toctree:: + :maxdepth: 2 + + class-methods + components + transposition + decomposition + clearness-index diff --git a/docs/sphinx/source/reference/irradiance/transposition.rst b/docs/sphinx/source/reference/irradiance/transposition.rst new file mode 100644 index 0000000000..4749b5d5b9 --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/transposition.rst @@ -0,0 +1,16 @@ +.. currentmodule:: pvlib + +Transposition models +-------------------- + +.. autosummary:: + :toctree: ../generated/ + + irradiance.get_total_irradiance + irradiance.get_sky_diffuse + irradiance.isotropic + irradiance.perez + irradiance.haydavies + irradiance.klucher + irradiance.reindl + irradiance.king diff --git a/docs/sphinx/source/reference/pv_modeling.rst b/docs/sphinx/source/reference/pv_modeling.rst deleted file mode 100644 index 52c818851c..0000000000 --- a/docs/sphinx/source/reference/pv_modeling.rst +++ /dev/null @@ -1,203 +0,0 @@ -.. currentmodule:: pvlib - -PV Modeling -=========== - -Classes -------- - -The :py:class:`~pvsystem.PVSystem` class provides many methods that -wrap the functions listed below. See its documentation for details. - -.. autosummary:: - :toctree: generated/ - - pvsystem.PVSystem - -Incident angle modifiers ------------------------- - -.. autosummary:: - :toctree: generated/ - - iam.physical - iam.ashrae - iam.martin_ruiz - iam.martin_ruiz_diffuse - iam.sapm - iam.interp - iam.marion_diffuse - iam.marion_integrate - iam.schlick - iam.schlick_diffuse - -PV temperature models ---------------------- - -.. autosummary:: - :toctree: generated/ - - temperature.sapm_cell - temperature.sapm_module - temperature.sapm_cell_from_module - temperature.pvsyst_cell - temperature.faiman - temperature.faiman_rad - temperature.fuentes - temperature.ross - temperature.noct_sam - temperature.prilliman - pvsystem.PVSystem.get_cell_temperature - temperature.generic_linear - temperature.GenericLinearModel - -Temperature Model Parameters -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. currentmodule:: pvlib.temperature -.. autodata:: TEMPERATURE_MODEL_PARAMETERS - :annotation: - -.. currentmodule:: pvlib - -Single diode models -------------------- - -Functions relevant for single diode models. - -.. autosummary:: - :toctree: generated/ - - pvsystem.calcparams_cec - pvsystem.calcparams_desoto - pvsystem.calcparams_pvsyst - pvsystem.i_from_v - pvsystem.singlediode - pvsystem.v_from_i - pvsystem.max_power_point - ivtools.sdm.pvsyst_temperature_coeff - -Low-level functions for solving the single diode equation. - -.. autosummary:: - :toctree: generated/ - - singlediode.estimate_voc - singlediode.bishop88 - singlediode.bishop88_i_from_v - singlediode.bishop88_v_from_i - singlediode.bishop88_mpp - -Functions for fitting diode models - -.. autosummary:: - :toctree: generated/ - - ivtools.sde.fit_sandia_simple - ivtools.sdm.fit_cec_sam - ivtools.sdm.fit_desoto - -Inverter models (DC to AC conversion) -------------------------------------- - -.. autosummary:: - :toctree: generated/ - - pvsystem.PVSystem.get_ac - inverter.sandia - inverter.sandia_multi - inverter.adr - inverter.pvwatts - inverter.pvwatts_multi - -Functions for fitting inverter models - -.. autosummary:: - :toctree: generated/ - - inverter.fit_sandia - - -PV System Models ----------------- - -Sandia array performance model (SAPM) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. autosummary:: - :toctree: generated/ - - pvsystem.sapm - pvsystem.sapm_effective_irradiance - pvsystem.sapm_spectral_loss - inverter.sandia - temperature.sapm_cell - -Pvsyst model -^^^^^^^^^^^^ - -.. autosummary:: - :toctree: generated/ - - temperature.pvsyst_cell - pvsystem.calcparams_pvsyst - pvsystem.singlediode - ivtools.sdm.pvsyst_temperature_coeff - pvsystem.dc_ohms_from_percent - pvsystem.dc_ohmic_losses - -PVWatts model -^^^^^^^^^^^^^ - -.. autosummary:: - :toctree: generated/ - - pvsystem.pvwatts_dc - inverter.pvwatts - pvsystem.pvwatts_losses - -ADR model -^^^^^^^^^ - -.. autosummary:: - :toctree: generated/ - - pvarray.pvefficiency_adr - pvarray.fit_pvefficiency_adr - - -Estimating PV model parameters ------------------------------- - -Functions for fitting single diode models - -.. autosummary:: - :toctree: generated/ - - ivtools.sdm.fit_cec_sam - ivtools.sdm.fit_desoto - ivtools.sdm.fit_pvsyst_sandia - ivtools.sdm.fit_desoto_sandia - -Functions for fitting the single diode equation - -.. autosummary:: - :toctree: generated/ - - ivtools.sde.fit_sandia_simple - -Utilities for working with IV curve data - -.. autosummary:: - :toctree: generated/ - - ivtools.utils.rectify_iv_curve - ivtools.utils.astm_e1036 - -Other ------ - -.. autosummary:: - :toctree: generated/ - - pvsystem.retrieve_sam - pvsystem.scale_voltage_current_power diff --git a/docs/sphinx/source/reference/pv_modeling/iam.rst b/docs/sphinx/source/reference/pv_modeling/iam.rst new file mode 100644 index 0000000000..1871f9b4a2 --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/iam.rst @@ -0,0 +1,19 @@ +.. currentmodule:: pvlib + + +Incident angle modifiers +------------------------ + +.. autosummary:: + :toctree: ../generated/ + + iam.physical + iam.ashrae + iam.martin_ruiz + iam.martin_ruiz_diffuse + iam.sapm + iam.interp + iam.marion_diffuse + iam.marion_integrate + iam.schlick + iam.schlick_diffuse diff --git a/docs/sphinx/source/reference/pv_modeling/index.rst b/docs/sphinx/source/reference/pv_modeling/index.rst new file mode 100644 index 0000000000..3941672c8f --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/index.rst @@ -0,0 +1,27 @@ +.. currentmodule:: pvlib + +PV Modeling +=========== + +Classes +------- + +The :py:class:`~pvsystem.PVSystem` class provides many methods that +wrap the functions listed below. See its documentation for details. + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.PVSystem + + +.. toctree:: + :maxdepth: 2 + + iam + temperature + sdm + inverter + system_models + parameters + other diff --git a/docs/sphinx/source/reference/pv_modeling/inverter.rst b/docs/sphinx/source/reference/pv_modeling/inverter.rst new file mode 100644 index 0000000000..e6e623f28b --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/inverter.rst @@ -0,0 +1,22 @@ +.. currentmodule:: pvlib + + +Inverter models (DC to AC conversion) +------------------------------------- + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.PVSystem.get_ac + inverter.sandia + inverter.sandia_multi + inverter.adr + inverter.pvwatts + inverter.pvwatts_multi + +Functions for fitting inverter models + +.. autosummary:: + :toctree: ../generated/ + + inverter.fit_sandia diff --git a/docs/sphinx/source/reference/pv_modeling/other.rst b/docs/sphinx/source/reference/pv_modeling/other.rst new file mode 100644 index 0000000000..3eab4f17f3 --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/other.rst @@ -0,0 +1,11 @@ +.. currentmodule:: pvlib + + +Other +----- + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.retrieve_sam + pvsystem.scale_voltage_current_power diff --git a/docs/sphinx/source/reference/pv_modeling/parameters.rst b/docs/sphinx/source/reference/pv_modeling/parameters.rst new file mode 100644 index 0000000000..9b1817bd01 --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/parameters.rst @@ -0,0 +1,30 @@ +.. currentmodule:: pvlib + + +Estimating PV model parameters +------------------------------ + +Functions for fitting single diode models + +.. autosummary:: + :toctree: ../generated/ + + ivtools.sdm.fit_cec_sam + ivtools.sdm.fit_desoto + ivtools.sdm.fit_pvsyst_sandia + ivtools.sdm.fit_desoto_sandia + +Functions for fitting the single diode equation + +.. autosummary:: + :toctree: ../generated/ + + ivtools.sde.fit_sandia_simple + +Utilities for working with IV curve data + +.. autosummary:: + :toctree: ../generated/ + + ivtools.utils.rectify_iv_curve + ivtools.utils.astm_e1036 diff --git a/docs/sphinx/source/reference/pv_modeling/sdm.rst b/docs/sphinx/source/reference/pv_modeling/sdm.rst new file mode 100644 index 0000000000..bfd5103ebe --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/sdm.rst @@ -0,0 +1,39 @@ +.. currentmodule:: pvlib + + +Single diode models +------------------- + +Functions relevant for single diode models. + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.calcparams_cec + pvsystem.calcparams_desoto + pvsystem.calcparams_pvsyst + pvsystem.i_from_v + pvsystem.singlediode + pvsystem.v_from_i + pvsystem.max_power_point + ivtools.sdm.pvsyst_temperature_coeff + +Low-level functions for solving the single diode equation. + +.. autosummary:: + :toctree: ../generated/ + + singlediode.estimate_voc + singlediode.bishop88 + singlediode.bishop88_i_from_v + singlediode.bishop88_v_from_i + singlediode.bishop88_mpp + +Functions for fitting diode models + +.. autosummary:: + :toctree: ../generated/ + + ivtools.sde.fit_sandia_simple + ivtools.sdm.fit_cec_sam + ivtools.sdm.fit_desoto diff --git a/docs/sphinx/source/reference/pv_modeling/system_models.rst b/docs/sphinx/source/reference/pv_modeling/system_models.rst new file mode 100644 index 0000000000..f1333acdbb --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/system_models.rst @@ -0,0 +1,49 @@ +.. currentmodule:: pvlib + + +PV System Models +---------------- + +Sandia array performance model (SAPM) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :toctree: ../generated/ + + pvsystem.sapm + pvsystem.sapm_effective_irradiance + pvsystem.sapm_spectral_loss + inverter.sandia + temperature.sapm_cell + +Pvsyst model +^^^^^^^^^^^^ + +.. autosummary:: + :toctree: ../generated/ + + temperature.pvsyst_cell + pvsystem.calcparams_pvsyst + pvsystem.singlediode + ivtools.sdm.pvsyst_temperature_coeff + pvsystem.dc_ohms_from_percent + pvsystem.dc_ohmic_losses + +PVWatts model +^^^^^^^^^^^^^ + +.. autosummary:: + :toctree: generated/ + + pvsystem.pvwatts_dc + inverter.pvwatts + pvsystem.pvwatts_losses + +ADR model +^^^^^^^^^ + +.. autosummary:: + :toctree: generated/ + + pvarray.pvefficiency_adr + pvarray.fit_pvefficiency_adr diff --git a/docs/sphinx/source/reference/pv_modeling/temperature.rst b/docs/sphinx/source/reference/pv_modeling/temperature.rst new file mode 100644 index 0000000000..4c0c7c596b --- /dev/null +++ b/docs/sphinx/source/reference/pv_modeling/temperature.rst @@ -0,0 +1,28 @@ +.. currentmodule:: pvlib + + +PV temperature models +--------------------- + +.. autosummary:: + :toctree: ../generated/ + + temperature.sapm_cell + temperature.sapm_module + temperature.sapm_cell_from_module + temperature.pvsyst_cell + temperature.faiman + temperature.faiman_rad + temperature.fuentes + temperature.ross + temperature.noct_sam + temperature.prilliman + pvsystem.PVSystem.get_cell_temperature + temperature.generic_linear + temperature.GenericLinearModel + +Temperature Model Parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: pvlib.temperature +.. autodata:: TEMPERATURE_MODEL_PARAMETERS + :annotation: