Skip to content

Commit 55eea92

Browse files
committed
add a bunch of functions and methods. almost all
1 parent a794052 commit 55eea92

File tree

2 files changed

+197
-2
lines changed

2 files changed

+197
-2
lines changed

docs/sphinx/source/api.rst

Lines changed: 196 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,203 @@ corresponding procedural code.
3030
Solar Position
3131
==============
3232

33+
Functions and methods for calculating solar position.
34+
3335
.. autosummary::
3436
:toctree: generated/
3537

3638
pvlib.location.Location.get_solarposition
37-
pvlib.solarposition
39+
pvlib.solarposition.get_solarposition
40+
pvlib.solarposition.spa_python
41+
pvlib.solarposition.ephemeris
42+
pvlib.solarposition.pyephem
43+
pvlib.solarposition.spa_c
44+
45+
Additional functions for quantities closely related to solar position.
46+
47+
.. autosummary::
48+
:toctree: generated/
49+
50+
pvlib.solarposition.calc_time
51+
pvlib.solarposition.pyephem_earthsun_distance
52+
pvlib.solarposition.nrel_earthsun_distance
53+
54+
55+
Clear sky
56+
=========
57+
58+
.. autosummary::
59+
:toctree: generated/
60+
61+
pvlib.location.Location.get_clearsky
62+
pvlib.clearsky.ineichen
63+
pvlib.clearsky.lookup_linke_turbidity
64+
pvlib.clearsky.simplfied_solis
65+
pvlib.clearsky.haurwitz
66+
67+
68+
Airmass and atmospheric models
69+
==============================
70+
71+
.. autosummary::
72+
:toctree: generated/
73+
74+
pvlib.location.Location.get_airmass
75+
pvlib.atmosphere.absoluteairmass
76+
pvlib.atmosphere.relativeairmass
77+
pvlib.atmosphere.pres2alt
78+
pvlib.atmosphere.alt2pres
79+
pvlib.atmosphere.gueymard94_pw
80+
pvlib.atmosphere.first_solar_spectral_correction
81+
82+
83+
Irradiance
84+
==========
85+
86+
Functions for irradiance calculations.
87+
88+
.. autosummary::
89+
:toctree: generated/
90+
91+
pvlib.pvsystem.PVSystem.get_irradiance
92+
pvlib.pvsystem.PVSystem.get_aoi
93+
pvlib.tracking.SingleAxisTracker.get_irradiance
94+
pvlib.pvsystem.SingleAxisTracker.get_aoi
95+
96+
Functions for irradiance calculations.
97+
98+
.. autosummary::
99+
:toctree: generated/
100+
101+
pvlib.irradiance.extraradiation
102+
pvlib.irradiance.aoi
103+
pvlib.irradiance.aoi_projection
104+
pvlib.irradiance.poa_horizontal_ratio
105+
pvlib.irradiance.beam_component
106+
pvlib.irradiance.globalinplane
107+
pvlib.irradiance.grounddiffuse
108+
109+
Transposition models.
110+
111+
.. autosummary::
112+
:toctree: generated/
113+
114+
pvlib.irradiance.total_irrad
115+
pvlib.irradiance.isotropic
116+
pvlib.irradiance.perez
117+
pvlib.irradiance.haydavies
118+
pvlib.irradiance.klucher
119+
pvlib.irradiance.reindl
120+
pvlib.irradiance.king
121+
122+
DNI estimation models.
123+
124+
.. autosummary::
125+
:toctree: generated/
126+
127+
pvlib.irradiance.disc
128+
pvlib.irradiance.dirint
129+
pvlib.irradiance.erbs
130+
pvlib.irradiance.liujordan
131+
132+
133+
PV Modeling
134+
===========
135+
136+
Classes.
137+
138+
.. autosummary::
139+
:toctree: generated/
140+
141+
pvlib.pvsystem.PVSystem
142+
pvlib.pvsystem.LocalizedPVSystem
143+
144+
Angle of incidence modifiers.
145+
146+
.. autosummary::
147+
:toctree: generated/
148+
149+
pvlib.pvsystem.physicaliam
150+
pvlib.pvsystem.ashraeiam
151+
pvlib.pvsystem.sapm_aoi_loss
152+
153+
Functions relevant for the single diode model.
154+
155+
.. autosummary::
156+
:toctree: generated/
157+
158+
pvlib.pvsystem.singlediode
159+
pvlib.pvsystem.calcparams_desoto
160+
pvlib.pvsystem.v_from_i
161+
pvlib.pvsystem.i_from_v
162+
163+
Functions relevant for the SAPM model.
164+
165+
.. autosummary::
166+
:toctree: generated/
167+
168+
pvlib.pvsystem.sapm
169+
pvlib.pvsystem.sapm_effective_irradiance
170+
pvlib.pvsystem.sapm_celltemp
171+
pvlib.pvsystem.sapm_spectral_loss
172+
pvlib.pvsystem.sapm_aoi_loss
173+
pvlib.pvsystem.snlinverter
174+
175+
PVWatts model.
176+
177+
.. autosummary::
178+
:toctree: generated/
179+
180+
pvlib.pvsystem.pvwatts_dc
181+
pvlib.pvsystem.pvwatts_ac
182+
pvlib.pvsystem.pvwatts_losses
183+
184+
185+
Other.
186+
187+
.. autosummary::
188+
:toctree: generated/
189+
190+
pvlib.pvsystem.retrieve_sam
191+
pvlib.pvsystem.systemdef
192+
pvlib.pvsystem.scale_voltage_current_power
193+
194+
195+
Tracking
196+
========
197+
198+
.. autosummary::
199+
:toctree: generated/
200+
201+
pvlib.tracking.SingleAxisTracker
202+
pvlib.tracking
203+
204+
205+
TMY
206+
===
207+
208+
.. autosummary::
209+
:toctree: generated/
210+
211+
pvlib.location.Location.from_tmy
212+
pvlib.tmy.readtmy2
213+
pvlib.tmy.readtmy3
214+
215+
216+
Forecasting
217+
===========
218+
219+
.. autosummary::
220+
:toctree: generated/
221+
222+
pvlib.forecast
223+
224+
225+
ModelChain
226+
==========
227+
228+
.. autosummary::
229+
:toctree: generated/
230+
231+
pvlib.modelchain.ModelChain
232+

docs/sphinx/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Contents
7070
========
7171

7272
.. toctree::
73-
:maxdepth: 2
73+
:maxdepth: 5
7474

7575
package_overview
7676
whatsnew

0 commit comments

Comments
 (0)