Documentation improvement #335

docs/sphinx/source/whatsnew/v0.4.6.rst

@@ -14,7 +14,7 @@ Bug fixes
 
 Enhancements
 ~~~~~~~~~~~~
-
+* Added default values to docstrings of all functions (:issue:`336`)
 
 API Changes
 ~~~~~~~~~~~
@@ -30,3 +30,4 @@ Contributors
 * Will Holmgren
 * Uwe Krien
 * Alaina Kafkes
+* Birgit Schachler

pvlib/atmosphere.py

@@ -114,7 +114,7 @@ def absoluteairmass(airmass_relative, pressure=101325.):
     airmass_relative : numeric
         The airmass at sea-level.
 
-    pressure : numeric
+    pressure : numeric, default 101325
         The site pressure in Pascal.
 
     Returns
@@ -152,7 +152,7 @@ def relativeairmass(zenith, model='kastenyoung1989'):
         model descriptions to determine which type of zenith angle is
         required. Apparent zenith angles must be calculated at sea level.
 
-    model : string
+    model : string, default 'kastenyoung1989'
         Available models include the following:
 
         * 'simple' - secant(apparent zenith angle) -
@@ -365,7 +365,7 @@ def first_solar_spectral_correction(pw, airmass_absolute, module_type=None,
     airmass_absolute : array-like
         absolute (pressure corrected) airmass.
 
-    module_type : None or string
+    module_type : None or string, default None
         a string specifying a cell type. Can be lower or upper case
         letters. Admits values of 'cdte', 'monosi', 'xsi', 'multisi',
         'polysi'. If provided, this input selects coefficients for the
@@ -382,7 +382,7 @@ def first_solar_spectral_correction(pw, airmass_absolute, module_type=None,
         Manufacturer 2 Model C from [3]_. Spectral Response (SR) of CIGS
         and a-Si modules used to derive coefficients can be found in [4]_ 
 
-    coefficients : array-like
+    coefficients : None or array-like, default None
         allows for entry of user defined spectral correction
         coefficients. Coefficients must be of length 6. Derivation of
         coefficients requires use of SMARTS and PV module quantum
@@ -617,8 +617,8 @@ def angstrom_aod_at_lambda(aod0, lambda0, alpha, lambda1=700.0):
         wavelength in nanometers corresponding to ``aod0``
     alpha : numeric
         Angstrom :math:`\alpha` exponent corresponding to ``aod0``
-    lambda1 : numeric
-        desired wavelength in nanometers, defaults to 700 nm
+    lambda1 : numeric, default 700
+        desired wavelength in nanometers
 
     Returns
     -------

pvlib/clearsky.py

@@ -40,10 +40,10 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
     linke_turbidity : numeric
         Linke Turbidity.
 
-    altitude : numeric
+    altitude : numeric, default 0
         Altitude above sea level in meters.
 
-    dni_extra : numeric
+    dni_extra : numeric, default 1364
         Extraterrestrial irradiance. The units of ``dni_extra``
         determine the units of the output.
 
@@ -164,10 +164,10 @@ def lookup_linke_turbidity(time, latitude, longitude, filepath=None,
 
     longitude : float
 
-    filepath : string
+    filepath : None or string, default None
         The path to the ``.mat`` file.
 
-    interp_turbidity : bool
+    interp_turbidity : bool, default True
         If ``True``, interpolates the monthly Linke turbidity values
         found in ``LinkeTurbidities.mat`` to daily values.
 
@@ -352,21 +352,21 @@ def simplified_solis(apparent_elevation, aod700=0.1, precipitable_water=1.,
     apparent_elevation : numeric
         The apparent elevation of the sun above the horizon (deg).
 
-    aod700 : numeric
+    aod700 : numeric, default 0.1
         The aerosol optical depth at 700 nm (unitless).
         Algorithm derived for values between 0 and 0.45.
 
-    precipitable_water : numeric
+    precipitable_water : numeric, default 1.0
         The precipitable water of the atmosphere (cm).
         Algorithm derived for values between 0.2 and 10 cm.
         Values less than 0.2 will be assumed to be equal to 0.2.
 
-    pressure : numeric
+    pressure : numeric, default 101325.0
         The atmospheric pressure (Pascals).
         Algorithm derived for altitudes between sea level and 7000 m,
         or 101325 and 41000 Pascals.
 
-    dni_extra : numeric
+    dni_extra : numeric, default 1364.0
         Extraterrestrial irradiance. The units of ``dni_extra``
         determine the units of the output.
 
@@ -569,29 +569,29 @@ def detect_clearsky(measured, clearsky, times, window_length,
     window_length : int
         Length of sliding time window in minutes. Must be greater than 2
         periods.
-    mean_diff : float
+    mean_diff : float, default 75
         Threshold value for agreement between mean values of measured
         and clearsky in each interval, see Eq. 6 in [1].
-    max_diff : float
+    max_diff : float, default 75
         Threshold value for agreement between maxima of measured and
         clearsky values in each interval, see Eq. 7 in [1].
-    lower_line_length : float
+    lower_line_length : float, default -5
         Lower limit of line length criterion from Eq. 8 in [1].
         Criterion satisfied when
         lower_line_length < line length difference < upper_line_length
-    upper_line_length : float
+    upper_line_length : float, default 10
         Upper limit of line length criterion from Eq. 8 in [1].
-    var_diff : float
+    var_diff : float, default 0.005
         Threshold value in Hz for the agreement between normalized
         standard deviations of rate of change in irradiance, see Eqs. 9
         through 11 in [1].
-    slope_dev : float
+    slope_dev : float, default 8
         Threshold value for agreement between the largest magnitude of
         change in successive values, see Eqs. 12 through 14 in [1].
-    max_iterations : int
+    max_iterations : int, default 20
         Maximum number of times to apply a different scaling factor to
         the clearsky and redetermine clear_samples. Must be 1 or larger.
-    return_components : bool
+    return_components : bool, default False
         Controls if additional output should be returned. See below.
 
     Returns

pvlib/forecast.py

@@ -216,11 +216,11 @@ def get_data(self, latitude, longitude, start, end,
             The start time.
         end: datetime or timestamp
             The end time.
-        vert_level: None, float or integer
+        vert_level: None, float or integer, default None
             Vertical altitude of interest.
-        variables: None or list
+        query_variables: None or list, default None
             If None, uses self.variables.
-        close_netcdf_data: bool
+        close_netcdf_data: bool, default True
             Controls if the temporary netcdf data file should be closed.
             Set to False to access the raw data.
 
@@ -309,7 +309,7 @@ def rename(self, data, variables=None):
         Parameters
         ----------
         data: DataFrame
-        variables: None or dict
+        variables: None or dict, default None
             If None, uses self.variables
 
         Returns
@@ -381,7 +381,7 @@ def cloud_cover_to_ghi_linear(self, cloud_cover, ghi_clear, offset=35,
             Cloud cover in %.
         ghi_clear: numeric
             GHI under clear sky conditions.
-        offset: numeric
+        offset: numeric, default 35
             Determines the minimum GHI.
         kwargs
             Not used.
@@ -421,7 +421,7 @@ def cloud_cover_to_irradiance_clearsky_scaling(self, cloud_cover,
         ----------
         cloud_cover : Series
             Cloud cover in %.
-        method : str
+        method : str, default 'linear'
             Method for converting cloud cover to GHI.
             'linear' is currently the only option.
         **kwargs
@@ -463,7 +463,7 @@ def cloud_cover_to_transmittance_linear(self, cloud_cover, offset=0.75,
         ----------
         cloud_cover : numeric
             Cloud cover in %.
-        offset : numeric
+        offset : numeric, default 0.75
             Determines the maximum transmittance.
         kwargs
             Not used.
@@ -520,7 +520,7 @@ def cloud_cover_to_irradiance(self, cloud_cover, how='clearsky_scaling',
         Parameters
         ----------
         cloud_cover : Series
-        how : str
+        how : str, default 'clearsky_scaling'
             Selects the method for conversion. Can be one of
             clearsky_scaling or liujordan.
         **kwargs
@@ -633,9 +633,9 @@ class GFS(ForecastModel):
 
     Parameters
     ----------
-    resolution: string
+    resolution: string, default 'half'
         Resolution of the model, either 'half' or 'quarter' degree.
-    set_type: string
+    set_type: string, default 'best'
         Type of model to pull data from.
 
     Attributes
@@ -700,7 +700,7 @@ def process_data(self, data, cloud_cover='total_clouds', **kwargs):
         ----------
         data: DataFrame
             Raw forecast data
-        cloud_cover: str
+        cloud_cover: str, default 'total_clouds'
             The type of cloud cover used to infer the irradiance.
 
         Returns
@@ -727,7 +727,7 @@ class HRRR_ESRL(ForecastModel):
 
     Parameters
     ----------
-    set_type: string
+    set_type: string, default 'best'
         Type of model to pull data from.
 
     Attributes
@@ -785,7 +785,7 @@ def process_data(self, data, cloud_cover='total_clouds', **kwargs):
         ----------
         data: DataFrame
             Raw forecast data
-        cloud_cover: str
+        cloud_cover: str, default 'total_clouds'
             The type of cloud cover used to infer the irradiance.
 
         Returns
@@ -812,7 +812,7 @@ class NAM(ForecastModel):
 
     Parameters
     ----------
-    set_type: string
+    set_type: string, default 'best'
         Type of model to pull data from.
 
     Attributes
@@ -866,7 +866,7 @@ def process_data(self, data, cloud_cover='total_clouds', **kwargs):
         ----------
         data: DataFrame
             Raw forecast data
-        cloud_cover: str
+        cloud_cover: str, default 'total_clouds'
             The type of cloud cover used to infer the irradiance.
 
         Returns
@@ -893,7 +893,7 @@ class HRRR(ForecastModel):
 
     Parameters
     ----------
-    set_type: string
+    set_type: string, default 'best'
         Type of model to pull data from.
 
     Attributes
@@ -949,7 +949,7 @@ def process_data(self, data, cloud_cover='total_clouds', **kwargs):
         ----------
         data: DataFrame
             Raw forecast data
-        cloud_cover: str
+        cloud_cover: str, default 'total_clouds'
             The type of cloud cover used to infer the irradiance.
 
         Returns
@@ -976,7 +976,7 @@ class NDFD(ForecastModel):
 
     Parameters
     ----------
-    set_type: string
+    set_type: string, default 'best'
         Type of model to pull data from.
 
     Attributes
@@ -1045,9 +1045,9 @@ class RAP(ForecastModel):
 
     Parameters
     ----------
-    resolution: string or int
+    resolution: string or int, default '20'
         The model resolution, either '20' or '40' (km)
-    set_type: string
+    set_type: string, default 'best'
         Type of model to pull data from.
 
     Attributes
@@ -1104,7 +1104,7 @@ def process_data(self, data, cloud_cover='total_clouds', **kwargs):
         ----------
         data: DataFrame
             Raw forecast data
-        cloud_cover: str
+        cloud_cover: str, default 'total_clouds'
             The type of cloud cover used to infer the irradiance.
 
         Returns