Skip to content
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

Model comparison tables #2329

Open
kandersolar opened this issue Dec 10, 2024 · 3 comments
Open

Model comparison tables #2329

kandersolar opened this issue Dec 10, 2024 · 3 comments

Comments

@kandersolar
Copy link
Member

SciPy's documentation has this nice table comparing root finding methods:

image

We should consider including similar tables in cases where pvlib provides semi-interchangeable alternatives, for example models for transposition, decomposition, and module temperature. Spectral mismatch has been previously suggested (comment). The structure/contents of the comparisons tables would depend on the models being compared, but they could (for example) compare:

  • transposition: necessary "extra" inputs (airmass, dni_extra, ...) and what POA components are output (horizon, circumsolar, isotropic)
  • spectral mismatch: necessary inputs and which cell technologies are directly supported

Where would the tables go in the documentation? They could go at the top of the corresponding API reference page, e.g. here, but I'd rather see them incorporated into new topic-focused User Guide pages along the lines of #1754.

@adriesse
Copy link
Member

Seems like a good idea to me. I would look for it under "Users Guide" if I knew it existed.

@RDaxini
Copy link
Contributor

RDaxini commented Dec 11, 2024

I also think the user guide is the right place. The new subsections created through #2302 would support this.

Could I work on one of these? I'd be happy to do the spectral mismatch one. If there are no takers for the transposition models one, I wouldn't mind working on that afterwards.

@echedey-ls
Copy link
Contributor

I agree with the already mentioned inclusion in the user guide, but for ease of accessing it, the newly created page / section can also be cross-referenced in the submodule page (maybe in some admonition?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants