8000 Refactor docstring params by echedey-ls · Pull Request #1790 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]
Skip to content

Refactor docstring params #1790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed

Refactor docstring params #1790

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8964a8c
Align reference
echedey-ls Jun 26, 2023
10812fb
Rework random matching
echedey-ls Jun 26, 2023
281dc67
First regex
echedey-ls Jun 26, 2023
f2a92b6
Second regex iteration
echedey-ls Jun 26, 2023
35fd3e7
Update irradiance.py
echedey-ls Jun 26, 2023
d72a654
Change excessive parentheses from default syntax in parameters
echedey-ls Jun 28, 2023
debcc63
Remove trailing dot
echedey-ls Jun 28, 2023
3497ff4
Remove colon after default
echedey-ls Jun 28, 2023
6500add
default None -> optional (#1574)
echedey-l 10000 s Jun 28, 2023
cdd022c
Merge branch 'main' into refactor-docstring-params
echedey-ls Jun 28, 2023
016206c
See also -> See Also (does not affect nothing)
echedey-ls Jun 28, 2023
db36922
Merge branch 'refactor-docstring-params' of https://github.com/echede…
echedey-ls Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
See also -> See Also (does not affect nothing)
  • Loading branch information
@echedey-ls
echedey-ls committed Jun 28, 2023
commit 016206c9195853289b22ae16e3d8d6d357dfb261
8 changes: 4 additions & 4 deletions pvlib/atmosphere.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ def bird_hulstrom80_aod_bb(aod380, aod500):
aod_bb : numeric
Broadband AOD. [unitless]

See also
See Also
--------
pvlib.atmosphere.kasten96_lt

Expand Down Expand Up @@ -407,7 +407,7 @@ def kasten96_lt(airmass_absolute, precipitable_water, aod_bb):
lt : numeric
Linke turbidity. [unitless]

See also
See Also
--------
pvlib.atmosphere.bird_hulstrom80_aod_bb
pvlib.atmosphere.angstrom_aod_at_lambda
Expand Down Expand Up @@ -488,7 +488,7 @@ def angstrom_aod_at_lambda(aod0, lambda0, alpha=1.14, lambda1=700.0):
aod1 : numeric
AOD at desired wavelength ``lambda1``. [unitless]

See also
See Also
--------
pvlib.atmosphere.angstrom_alpha

Expand Down Expand Up @@ -528,7 +528,7 @@ def angstrom_alpha(aod1, lambda1, aod2, lambda2):
Angstrom :math:`\alpha` exponent for wavelength in
``(lambda1, lambda2)``. [unitless]

See also
See Also
--------
pvlib.atmosphere.angstrom_aod_at_lambda
"""
Expand Down
4 changes: 2 additions & 2 deletions pvlib/bifacial/infinite_sheds.py
10000 View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ def get_irradiance_poa(surface_tilt, surface_azimuth, solar_zenith,
Photovoltaic Specialists Conference (PVSC), 2019, pp. 1282-1287.
:doi:`10.1109/PVSC40753.2019.8980572`.

See also
See Also
--------
get_irradiance
"""
Expand Down Expand Up @@ -518,7 +518,7 @@ def get_irradiance(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth,
Photovoltaic Specialists Conference (PVSC), 2019, pp. 1282-1287.
:doi:`10.1109/PVSC40753.2019.8980572`.

See also
See Also
--------
get_irradiance_poa
"""
Expand Down
4 changes: 2 additions & 2 deletions pvlib/clearsky.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
DataFrame/OrderedDict contains the columns/keys
``'dhi', 'dni', 'ghi'``.

See also
See Also
--------
lookup_linke_turbidity
pvlib.location.Location.get_clearsky
Expand Down Expand Up @@ -909,7 +909,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,
DataFrame/OrderedDict contains the columns/keys
``'dhi', 'dni', 'ghi', 'direct_horizontal'`` in [W/m^2].

See also
See Also
--------
pvlib.atmosphere.bird_hulstrom80_aod_bb
pvlib.atmosphere.get_relative_airmass
Expand Down
6 changes: 3 additions & 3 deletions pvlib/inverter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def sandia(v_dc, p_dc, inverter):

.. [2] System Advisor Model web page. https://sam.nrel.gov.

See also
See Also
--------
pvlib.pvsystem.retrieve_sam
'''
Expand Down Expand Up @@ -182,7 +182,7 @@ def sandia_multi(v_dc, p_dc, inverter):
Efficiency Of Inverters With Multiple Inputs", 49th IEEE Photovoltaic
Specialist Conference, Philadelphia, PA, USA. June 2022.

See also
See Also
--------
pvlib.inverter.sandia
'''
Expand Down Expand Up @@ -273,7 +273,7 @@ def adr(v_dc, p_dc, inverter, vtol=0.10):
of Photovoltaic Inverters", 33rd IEEE Photovoltaic Specialist
Conference (PVSC), June 2008

See also
See Also
--------
pvlib.inverter.sandia
pvlib.pvsystem.retrieve_sam
Expand Down
4 changes: 2 additions & 2 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2223,7 +2223,7 @@ def erbs(ghi, zenith, datetime_or_doy, min_cos_zenith=0.065, max_zenith=87):
diffuse radiation fraction for hourly, daily and monthly-average
global radiation, Solar Energy 28(4), pp 293-302, 1982. Eq. 1

See also
See Also
--------
dirint
disc
Expand Down Expand Up @@ -2321,7 +2321,7 @@ def boland(ghi, solar_zenith, datetime_or_doy, a_coeff=8.645, b_coeff=0.613,
Environmetrics 12(2), pp 103-116, 2001,
:doi:`10.1002/1099-095X(200103)12:2%3C103::AID-ENV447%3E3.0.CO;2-2`

See also
See Also
--------
dirint
disc
Expand Down
2364
4 changes: 2 additions & 2 deletions pvlib/location.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class Location:
name : string, optional
Sets the name attribute of the Location object.

See also
See Also
--------
pvlib.pvsystem.PVSystem
"""
Expand Down Expand Up @@ -293,7 +293,7 @@ def get_airmass(self, times=None, solar_position=None,
airmass : DataFrame
Columns are 'airmass_relative', 'airmass_absolute'

See also
See Also
--------
pvlib.atmosphere.get_relative_airmass
"""
Expand Down
12 changes: 6 additions & 6 deletions pvlib/modelchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@ def pvwatts_dc(self):
-------
self

See also
See Also
--------
pvlib.pvsystem.PVSystem.pvwatts_dc
pvlib.pvsystem.PVSystem.scale_voltage_current_power
Expand Down Expand Up @@ -1539,7 +1539,7 @@ def prepare_inputs(self, weather):
Assigns attributes to ``results``: ``times``, ``weather``,
``solar_position``, ``airmass``, ``total_irrad``, ``aoi``, ``albedo``.

See also
See Also
--------
ModelChain.complete_irradiance
"""
Expand Down Expand Up @@ -1621,7 +1621,7 @@ def prepare_inputs_from_poa(self, data):
Assigns attributes to ``results``: ``times``, ``weather``,
``total_irrad``, ``solar_position``, ``airmass``, ``aoi``.

See also
See Also
--------
pvlib.modelchain.ModelChain.prepare_inputs
"""
Expand Down Expand Up @@ -1798,7 +1798,7 @@ def run_model(self, weather):
``losses``, ``diode_params`` (if dc_model is a single diode
model).

See also
See Also
--------
pvlib.modelchain.ModelChain.run_model_from_poa
pvlib.modelchain.ModelChain.run_model_from_effective_irradiance
Expand Down Expand Up @@ -1859,7 +1859,7 @@ def run_model_from_poa(self, data):
``losses``, ``diode_params`` (if dc_model is a single diode
model).

See also
See Also
--------
pvlib.modelchain.ModelChain.run_model
pvlib.modelchain.ModelChain.run_model_from_effective_irradiance
Expand Down Expand Up @@ -1955,7 +1955,7 @@ def run_model_from_effective_irradiance(self, data):
``effective_irradiance``, ``cell_temperature``, ``dc``, ``ac``,
``losses``, ``diode_params`` (if dc_model is a single diode model).

See also
See Also
--------
pvlib.modelchain.ModelChain.run_model
pvlib.modelchain.ModelChain.run_model_from_poa
Expand Down
4 changes: 2 additions & 2 deletions pvlib/pvarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def pvefficiency_adr(effective_irradiance, temp_cell,
are array-like they must be the same shape or broadcastable to the
same shape.

See also
See Also
--------
pvlib.pvarray.fit_pvefficiency_adr

Expand Down Expand Up @@ -175,7 +175,7 @@ def fit_pvefficiency_adr(effective_irradiance, temp_cell, eta,
would consist of 6 operating points covering low, medium and high
irradiance levels at two operating temperatures.

See also
See Also
--------
pvlib.pvarray.pvefficiency_adr
scipy.optimize.curve_fit
Expand Down
12 changes: 6 additions & 6 deletions pvlib/pvsystem.py
View file 10000
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ class PVSystem:
ValueError
If `arrays` is not None and has length 0.

See also
See Also
--------
pvlib.location.Location
"""
Expand Down Expand Up @@ -351,7 +351,7 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
Column names are: ``'poa_global', 'poa_direct', 'poa_diffuse',
'poa_sky_diffuse', 'poa_ground_diffuse'``.

See also
See Also
--------
pvlib.irradiance.get_total_irradiance
"""
Expand Down Expand Up @@ -770,7 +770,7 @@ def get_ac(self, model, p_dc, v_dc=None):
ValueError
If model='adr' and the PVSystem has more than one array.

See also
See Also
--------
pvlib.inverter.sandia
pvlib.inverter.sandia_multi
Expand Down Expand Up @@ -1110,7 +1110,7 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
Column names are: ``'poa_global', 'poa_direct', 'poa_diffuse',
'poa_sky_diffuse', 'poa_ground_diffuse'``.

See also
See Also
--------
:py:func:`pvlib.irradiance.get_total_irradiance`
"""
Expand Down Expand Up @@ -2313,7 +2313,7 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
.. [1] D. King et al, "Sandia Photovoltaic Array Performance Model",
SAND2004-3535, Sandia National Laboratories, Albuquerque, NM

See also
See Also
--------
pvlib.iam.sapm
pvlib.spectrum.spectral_factor_sapm
Expand Down Expand Up @@ -2414,7 +2414,7 @@ def singlediode(photocurrent, saturation_current, resistance_series,
* i - IV curve current in amperes.
* v - IV curve voltage in volts.

See also
See Also
--------
calcparams_desoto
calcparams_cec
Expand Down
10 changes: 5 additions & 5 deletions pvlib/solarposition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
.. [2] USNO delta T:
http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term

See also
See Also
--------
pyephem, spa_python, ephemeris
"""
Expand Down Expand Up @@ -346,7 +346,7 @@ def spa_python(time, latitude, longitude,
.. [3] USNO delta T:
http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term

See also
See Also
--------
pyephem, spa_c, ephemeris
"""
Expand Down Expand Up @@ -539,7 +539,7 @@ def sun_rise_set_transit_ephem(times, latitude, longitude,
index is the same as input `time` argument
columns are 'sunrise', 'sunset', and 'transit'

See also
See Also
--------
pyephem
"""
Expand Down Expand Up @@ -625,7 +625,7 @@ def pyephem(time, latitude, longitude, altitude=0, pressure=101325,
apparent_azimuth, azimuth,
apparent_zenith, zenith.

See also
See Also
--------
spa_python, spa_c, ephemeris
"""
Expand Down Expand Up @@ -725,7 +725,7 @@ def ephemeris(time, latitude, longitude, pressure=101325, temperature=12):
.. [1] Grover Hughes' class and related class materials on Engineering
Astronomy at Sandia National Laboratories, 1985.

See also
See Also
--------
pyephem, spa_c, spa_python

Expand Down
18 changes: 9 additions & 9 deletions pvlib/temperature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT,
Model", SAND Report 3535, Sandia National Laboratories, Albuquerque,
NM.

See also
See Also
--------
sapm_cell_from_module
sapm_module
Expand Down Expand Up @@ -212,7 +212,7 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b):
Model", SAND Report 3535, Sandia National Laboratories, Albuquerque,
NM.

See also
See Also
--------
sapm_cell
sapm_cell_from_module
Expand Down Expand Up @@ -282,7 +282,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
Model", SAND Report 3535, Sandia National Laboratories, Albuquerque,
NM.

See also
See Also
--------
sapm_cell
sapm_module
Expand Down Expand Up @@ -439,7 +439,7 @@ def faiman(poa_global, temp_air, wind_speed=1.0, u0=25.0, u1=6.84):
.. [3] "IEC 61853-3 Photovoltaic (PV) module performance testing and energy
rating - Part 3: Energy rating of PV modules". IEC, Geneva, 2018.

See also
See Also
--------
pvlib.temperature.faiman_rad

Expand Down Expand Up @@ -545,7 +545,7 @@ def faiman_rad(poa_global, temp_air, wind_speed=1.0, ir_down=None,
Models by Incorporating Radiative Losses to the Sky". SAND2022-11604.
:doi:`10.2172/1884890`

See also
See Also
--------
pvlib.temperature.faiman

Expand Down Expand Up @@ -1133,7 +1133,7 @@ def generic_linear(poa_global, temp_air, wind_speed, u_const, du_wind,
Model Equivalence and Parameter Translation". 2022 IEEE
Photovoltaic Specialists Conference (PVSC), 2022.

See also
See Also
--------
pvlib.temperature.GenericLinearModel
"""
Expand Down Expand Up @@ -1203,7 +1203,7 @@ class GenericLinearModel():
>>> pvsyst_cell(800, 20, 1, **parmdict)
53.33333333333333

See also
See Also
--------
pvlib.temperature.generic_linear
'''
Expand Down Expand Up @@ -1248,7 +1248,7 @@ def __call__(self, poa_global, temp_air, wind_speed,
-------
numeric, values in degrees Celsius

See also
See Also
--------
get_generic
pvlib.temperature.generic_linear
Expand All @@ -1269,7 +1269,7 @@ def get_generic_linear(self):
-------
model_parameters : dict

See also
See Also
--------
pvlib.temperature.generic_linear
'''
Expand Down
2 changes: 1 addition & 1 deletion pvlib/tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ def _golden_sect_DataFrame(params, lower, upper, func, atol=1e-8):
This function will find the points where the function is maximized.
Returns nan where lower or upper is nan, or where func evaluates to nan.

See also
See Also
--------
pvlib.singlediode._pwr_optfcn
"""
Expand Down
Loading
0