Skip to content

[discussion only] a bunch of api changes #467

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.

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 1 commit into from
Closed
Changes from all commits
Commits
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
54 changes: 31 additions & 23 deletions docs/sphinx/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,14 @@ Airmass and atmospheric models
:toctree: generated/

location.Location.get_airmass
atmosphere.absoluteairmass
atmosphere.relativeairmass
atmosphere.absolute_airmass
atmosphere.get_relative_airmass
atmosphere.pres2alt
atmosphere.alt2pres
atmosphere.gueymard94_pw
atmosphere.first_solar_spectral_correction
atmosphere.pw_gueymard94
atmosphere.spectral_correction_first_solar # consider spectral module
atmosphere.spectral_corrrection_sapm
atmosphere.aod_bb_bird_hulstrom80
atmosphere.bird_hulstrom80_aod_bb
atmosphere.kasten96_lt
atmosphere.angstrom_aod_at_lambda
Expand All @@ -133,21 +135,23 @@ Decomposing and combining irradiance
.. autosummary::
:toctree: generated/

irradiance.extraradiation
irradiance.get_extra_radiation
irradiance.aoi
irradiance.aoi_projection
irradiance.poa_horizontal_ratio
irradiance.beam_component
irradiance.globalinplane
irradiance.grounddiffuse
irradiance.poa_components
irradiance.get_ground_diffuse

Transposition models
--------------------

.. autosummary::
:toctree: generated/

irradiance.total_irrad
# consider transposition module, though I lean towards no.
irradiance.get_total_irradiance
irradiance.get_sky_diffuse
irradiance.isotropic
irradiance.perez
irradiance.haydavies
Expand Down Expand Up @@ -189,9 +193,10 @@ AOI modifiers
.. autosummary::
:toctree: generated/

pvsystem.physicaliam
pvsystem.ashraeiam
pvsystem.sapm_aoi_loss
pvsystem.iam_physical # consider iam module
pvsystem.iam_ashrae
pvsystem.iam_sapm


Single diode model
------------------
Expand All @@ -201,7 +206,7 @@ Functions relevant for the single diode model.
.. autosummary::
:toctree: generated/

pvsystem.calcparams_desoto
pvsystem.calcparams_desoto # consider singlediode module
pvsystem.i_from_v
pvsystem.singlediode
pvsystem.v_from_i
Expand All @@ -214,22 +219,22 @@ Functions relevant for the SAPM model.
.. autosummary::
:toctree: generated/

pvsystem.sapm
pvsystem.sapm_effective_irradiance
pvsystem.sapm_celltemp
pvsystem.sapm_spectral_loss
pvsystem.sapm_aoi_loss
pvsystem.snlinverter
pvsystem.sapm # dc_sapm?
pvsystem.effective_irradiance_sapm
pvsystem.celltemp_sapm
pvsystem.spectral_loss_sapm
pvsystem.iam_sapm
pvsystem.inverter_sapm

PVWatts model
-------------

.. autosummary::
:toctree: generated/

pvsystem.pvwatts_dc
pvsystem.pvwatts_ac
pvsystem.pvwatts_losses
pvsystem.pvwatts_dc # dc_pvwatts?
pvsystem.pvwatts_ac # ac_pvwatts?
pvsystem.pvwatts_losses # losses_pvwatts?


Other
Expand Down Expand Up @@ -275,6 +280,8 @@ TMY

Methods and functions for reading data from TMY files.

Move to IO subpackage

.. autosummary::
:toctree: generated/

Expand Down Expand Up @@ -421,6 +428,7 @@ on the information in the associated :py:class:`~pvsystem.PVSystem` object.
.. autosummary::
:toctree: generated/

# note how ModelChain organizes choices
modelchain.ModelChain.infer_dc_model
modelchain.ModelChain.infer_ac_model
modelchain.ModelChain.infer_aoi_model
Expand All @@ -436,5 +444,5 @@ Functions for power modeling.
.. autosummary::
:toctree: generated/

modelchain.basic_chain
modelchain.get_orientation
modelchain.basic_chain # deprecate
modelchain.get_orientation # deprecate