Skip to content

Commit f67ecff

Browse files
authored
fix snlinverter and extraradiation doc string problems (#243)
* fix snlinverter and extraradiation doc string problems * update whatsnew
1 parent 5b02d1f commit f67ecff

File tree

3 files changed

+35
-32
lines changed

3 files changed

+35
-32
lines changed

docs/sphinx/source/whatsnew/v0.4.1.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Documentation
2020

2121
* Fixed a typo in the pvsystem.sapm returns description. (:issue:`234`)
2222
* Replaced nosetests references with py.test. (:issue:`232`)
23+
* Improve the rendering of the snlinverter doc string. (:issue:`242`)
2324

2425

2526
Code Contributors

pvlib/irradiance.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ def extraradiation(datetime_or_doy, solar_constant=1366.1, method='spencer',
4343
4444
Parameters
4545
----------
46-
datetime_or_doy : int, float, array, date, datetime, datetime64,
47-
Timestamp, DatetimeIndex
46+
datetime_or_doy : numeric, array, date, datetime, Timestamp, DatetimeIndex
4847
Day of year, array of days of year, or datetime-like object
4948
5049
solar_constant : float

pvlib/pvsystem.py

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1922,7 +1922,7 @@ def i_from_v(resistance_shunt, resistance_series, nNsVth, voltage,
19221922

19231923

19241924
def snlinverter(v_dc, p_dc, inverter):
1925-
'''
1925+
r'''
19261926
Converts DC power and voltage to AC power using Sandia's
19271927
Grid-Connected PV Inverter model.
19281928
@@ -1950,35 +1950,7 @@ def snlinverter(v_dc, p_dc, inverter):
19501950
Grid-Connected Photovoltaic Inverter Model (SAND 2007-5036) [1].
19511951
A set of inverter performance parameters are provided with
19521952
pvlib, or may be generated from a System Advisor Model (SAM) [2]
1953-
library using retrievesam.
1954-
1955-
Required DataFrame columns are:
1956-
1957-
====== ============================================================
1958-
Column Description
1959-
====== ============================================================
1960-
Pac0 AC-power output from inverter based on input power
1961-
and voltage (W)
1962-
Pdc0 DC-power input to inverter, typically assumed to be equal
1963-
to the PV array maximum power (W)
1964-
Vdc0 DC-voltage level at which the AC-power rating is achieved
1965-
at the reference operating condition (V)
1966-
Ps0 DC-power required to start the inversion process, or
1967-
self-consumption by inverter, strongly influences inverter
1968-
efficiency at low power levels (W)
1969-
C0 Parameter defining the curvature (parabolic) of the
1970-
relationship between ac-power and dc-power at the reference
1971-
operating condition, default value of zero gives a
1972-
linear relationship (1/W)
1973-
C1 Empirical coefficient allowing Pdco to vary linearly
1974-
with dc-voltage input, default value is zero (1/V)
1975-
C2 Empirical coefficient allowing Pso to vary linearly with
1976-
dc-voltage input, default value is zero (1/V)
1977-
C3 Empirical coefficient allowing Co to vary linearly with
1978-
dc-voltage input, default value is zero (1/V)
1979-
Pnt AC-power consumed by inverter at night (night tare) to
1980-
maintain circuitry required to sense PV array voltage (W)
1981-
====== ============================================================
1953+
library using retrievesam. See Notes for required keys.
19821954
19831955
Returns
19841956
-------
@@ -1992,6 +1964,37 @@ def snlinverter(v_dc, p_dc, inverter):
19921964
tracking (MPPT) voltage windows or maximum current limits of the
19931965
inverter.
19941966
1967+
Notes
1968+
-----
1969+
1970+
Required inverter keys are:
1971+
1972+
====== ============================================================
1973+
Column Description
1974+
====== ============================================================
1975+
Pac0 AC-power output from inverter based on input power
1976+
and voltage (W)
1977+
Pdc0 DC-power input to inverter, typically assumed to be equal
1978+
to the PV array maximum power (W)
1979+
Vdc0 DC-voltage level at which the AC-power rating is achieved
1980+
at the reference operating condition (V)
1981+
Ps0 DC-power required to start the inversion process, or
1982+
self-consumption by inverter, strongly influences inverter
1983+
efficiency at low power levels (W)
1984+
C0 Parameter defining the curvature (parabolic) of the
1985+
relationship between ac-power and dc-power at the reference
1986+
operating condition, default value of zero gives a
1987+
linear relationship (1/W)
1988+
C1 Empirical coefficient allowing Pdco to vary linearly
1989+
with dc-voltage input, default value is zero (1/V)
1990+
C2 Empirical coefficient allowing Pso to vary linearly with
1991+
dc-voltage input, default value is zero (1/V)
1992+
C3 Empirical coefficient allowing Co to vary linearly with
1993+
dc-voltage input, default value is zero (1/V)
1994+
Pnt AC-power consumed by inverter at night (night tare) to
1995+
maintain circuitry required to sense PV array voltage (W)
1996+
====== ============================================================
1997+
19951998
References
19961999
----------
19972000
[1] SAND2007-5036, "Performance Model for Grid-Connected

0 commit comments

Comments
 (0)