Here's are two things that would be nice to have in the docs, derived largely or entirely from conversation with @spaneja:
Relevant class methods don't have their own docs page
For example: PVEngine has its own page (link), but its fit() method does not, making it hard to know what parameters the method takes (without referring to the tutorials, anyway). I think it should be straightforward to get this working just with sphinx configuration changes.
Irradiance component names and meanings are not documented
It's possible to extract not only total incident and absorbed irradiance but also various sub-components. The docs have an example of this:
It would be nice for the available component names (e.g. reflection) to be listed somewhere, along with specific descriptions of what each name refers to (e.g. does reflection include ground-reflected irradiance, or just row-row reflections?).
Originally posted in https://github.com/SunPower/pvfactors/issues/143:
Here's are two things that would be nice to have in the docs, derived largely or entirely from conversation with @spaneja:
Relevant class methods don't have their own docs page
For example: PVEngine has its own page (link), but its
fit()method does not, making it hard to know what parameters the method takes (without referring to the tutorials, anyway). I think it should be straightforward to get this working just with sphinx configuration changes.Irradiance component names and meanings are not documented
It's possible to extract not only total incident and absorbed irradiance but also various sub-components. The docs have an example of this:
https://github.com/pvlib/solarfactors/blob/21d48655ce6acd3ab1955f98212cbdd3e3cc8351/docs/tutorials/Run_full_timeseries_simulations.ipynb?short_path=2c386fd#L232-L235
It would be nice for the available component names (e.g.
reflection) to be listed somewhere, along with specific descriptions of what each name refers to (e.g. doesreflectioninclude ground-reflected irradiance, or just row-row reflections?).