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

Detailed explanation of racking_module and module_type in PVSystem docstring #1942

Open
matsuobasho opened this issue Dec 26, 2023 · 2 comments

Comments

@matsuobasho
Copy link
Contributor

matsuobasho commented Dec 26, 2023

Is your feature request related to a problem? Please describe.
Without prior knowledge, the racking_model and the module_type parameters are not properly explained, especially with respect to how their combination is used to select a temperature model.

Describe the solution you'd like
A detailed description racking_model and module_type and how/why certain combinations are then used to select a SAPM or PVSyst temperature model. This description should be in the notes section of PVSystem and Array.

It would also be useful to include a brief version of this description in the PVSystem user guide.

Also, note that currently the docstring of the racking_model argument in both PVSystem and FixedMount is incomplete - it is missing the freestanding option. This needs to be fixed.

Describe alternatives you've considered
I've searched the codebase and tutorials for an explanation.

@matsuobasho
Copy link
Contributor Author

matsuobasho commented Feb 6, 2024

In addition to the racking_model incompleteness mentioned above, the docstring states that default is 'open_rack', but the code has the default as None. Which is one the intended default?

@cwhanse
Copy link
Member

cwhanse commented Feb 15, 2024

IMO None is the intended default and the docstring should be corrected.

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

No branches or pull requests

2 participants