Skip to content
Snippets Groups Projects
Commit 3a83f0f0 authored by Bouvry Arnaud's avatar Bouvry Arnaud
Browse files

[docs] Add partial docstring to...

[docs] Add partial docstring to MODULES.PHOTOVOLTAICS.production.PV_Production.compute_global_tilted_irradiance

Add partial docstring to MODULES.PHOTOVOLTAICS.production.PV_Production.compute_global_tilted_irradiance to document the inputs (variables and units). Some are still missing and tagged with TODO.
parent 0b552d7c
No related branches found
No related tags found
1 merge request!21v1.1.0
......@@ -149,7 +149,22 @@ class PV_Production:
def compute_global_tilted_irradiance(self, Rb, GHI_ground, albedo, BHI,
DHI, Ai, f, SF, tiltY):
"""
Args:
Rb: TODO
GHI_ground: GHI reaching the ground [W/m²]
albedo: albedo [-]
BHI: Beam Horizontal Irradiance [W/m²]
DHI: Diffuse Horizontal Irradiance [W/m²]
Ai: Anisotropy index
f: modulating factor
SF: ? TODO
tiltY: panel inclination [?] TODO
Returns:
GTI: Global Tilted Irradiance [W/m²]
"""
one = np.ones((len(Ai)))
zero_vector = np.zeros((len(Ai))) # TODO remove ? this is unused
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment