Skip to content

Commit 516a040

Browse files
committed
more modelchain and forecast stuff
1 parent 602e6cf commit 516a040

File tree

1 file changed

+118
-2
lines changed

1 file changed

+118
-2
lines changed

docs/sphinx/source/api.rst

Lines changed: 118 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,16 +195,20 @@ Other.
195195
Tracking
196196
========
197197

198+
Methods and functions for tracking.
199+
198200
.. autosummary::
199201
:toctree: generated/
200202

201203
pvlib.tracking.SingleAxisTracker
202-
pvlib.tracking
204+
pvlib.tracking.singleaxis
203205

204206

205207
TMY
206208
===
207209

210+
Methods and functions for reading data from TMY files.
211+
208212
.. autosummary::
209213
:toctree: generated/
210214

@@ -219,14 +223,126 @@ Forecasting
219223
.. autosummary::
220224
:toctree: generated/
221225

222-
pvlib.forecast
226+
pvlib.forecast.GFS
227+
pvlib.forecast.NAM
228+
pvlib.forecast.RAP
229+
pvlib.forecast.HRRR
230+
pvlib.forecast.HRRR_ESRL
231+
pvlib.forecast.NDFD
232+
233+
Methods for getting data.
234+
235+
.. autosummary::
236+
:toctree: generated/
237+
238+
pvlib.forecast.ForecastModel.get_data
239+
pvlib.forecast.ForecastModel.get_processed_data
240+
241+
Common methods for processing data.
242+
243+
.. autosummary::
244+
:toctree: generated/
245+
246+
pvlib.forecast.ForecastModel.process_data
247+
pvlib.forecast.ForecastModel.rename
248+
pvlib.forecast.ForecastModel.cloud_cover_to_ghi_linear
249+
pvlib.forecast.ForecastModel.cloud_cover_to_irradiance_clearsky_scaling
250+
pvlib.forecast.ForecastModel.cloud_cover_to_transmittance_linear
251+
pvlib.forecast.ForecastModel.cloud_cover_to_irradiance_liujordan
252+
pvlib.forecast.ForecastModel.cloud_cover_to_irradiance
253+
pvlib.forecast.ForecastModel.kelvin_to_celsius
254+
pvlib.forecast.ForecastModel.isobaric_to_ambient_temperature
255+
pvlib.forecast.ForecastModel.uv_to_speed
256+
pvlib.forecast.ForecastModel.gust_to_speed
257+
258+
Methods for supporting IO.
259+
260+
.. autosummary::
261+
:toctree: generated/
262+
263+
pvlib.forecast.ForecastModel.set_dataset
264+
pvlib.forecast.ForecastModel.set_query_latlon
265+
pvlib.forecast.ForecastModel.set_location
266+
pvlib.forecast.ForecastModel.set_time
223267

224268

225269
ModelChain
226270
==========
227271

272+
Creating a ModelChain object.
273+
228274
.. autosummary::
229275
:toctree: generated/
230276

231277
pvlib.modelchain.ModelChain
232278

279+
Running a ModelChain.
280+
281+
.. autosummary::
282+
:toctree: generated/
283+
284+
pvlib.modelchain.ModelChain.run_model
285+
pvlib.modelchain.ModelChain.complete_irradiance
286+
pvlib.modelchain.ModelChain.prepare_inputs
287+
288+
Simple ModelChain attributes:
289+
290+
``system, location, clearsky_model, transposition_model,
291+
solar_position_method, airmass_model``
292+
293+
ModelChain properties that are aliases for your specific modeling functions.
294+
295+
.. autosummary::
296+
:toctree: generated/
297+
298+
pvlib.modelchain.ModelChain.orientation_strategy
299+
pvlib.modelchain.ModelChain.dc_model
300+
pvlib.modelchain.ModelChain.ac_model
301+
pvlib.modelchain.ModelChain.aoi_model
302+
pvlib.modelchain.ModelChain.spectral_model
303+
pvlib.modelchain.ModelChain.temp_model
304+
pvlib.modelchain.ModelChain.losses_model
305+
pvlib.modelchain.ModelChain.effective_irradiance_model
306+
307+
ModelChain model definitions.
308+
309+
.. autosummary::
310+
:toctree: generated/
311+
312+
pvlib.modelchain.ModelChain.sapm
313+
pvlib.modelchain.ModelChain.singlediode
314+
pvlib.modelchain.ModelChain.pvwatts_dc
315+
pvlib.modelchain.ModelChain.snlinverter
316+
pvlib.modelchain.ModelChain.adrinverter
317+
pvlib.modelchain.ModelChain.pvwatts_inverter
318+
pvlib.modelchain.ModelChain.ashrae_aoi_loss
319+
pvlib.modelchain.ModelChain.physical_aoi_loss
320+
pvlib.modelchain.ModelChain.sapm_aoi_loss
321+
pvlib.modelchain.ModelChain.no_aoi_loss
322+
pvlib.modelchain.ModelChain.first_solar_spectral_loss
323+
pvlib.modelchain.ModelChain.sapm_spectral_loss
324+
pvlib.modelchain.ModelChain.no_spectral_loss
325+
pvlib.modelchain.ModelChain.sapm_temp
326+
pvlib.modelchain.ModelChain.pvwatts_losses
327+
pvlib.modelchain.ModelChain.no_extra_losses
328+
329+
Methods that automatically determine which models should be used based
330+
on the information in the associated :py:class:`~pvsystem.PVSystem` object.
331+
332+
.. autosummary::
333+
:toctree: generated/
334+
335+
pvlib.modelchain.ModelChain.infer_dc_model
336+
pvlib.modelchain.ModelChain.infer_ac_model
337+
pvlib.modelchain.ModelChain.infer_aoi_model
338+
pvlib.modelchain.ModelChain.infer_spectral_model
339+
pvlib.modelchain.ModelChain.infer_temp_model
340+
pvlib.modelchain.ModelChain.infer_losses_model
341+
342+
Functions for power modeling.
343+
344+
.. autosummary::
345+
:toctree: generated/
346+
347+
pvlib.modelchain.basic_chain
348+
pvlib.modelchain.get_orientation

0 commit comments

Comments
 (0)