Skip to content

Naming pattern for IAM functions #680

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
cwhanse opened this issue Mar 28, 2019 · 3 comments · Fixed by #783
Closed

Naming pattern for IAM functions #680

cwhanse opened this issue Mar 28, 2019 · 3 comments · Fixed by #783
Milestone

Comments

@cwhanse
Copy link
Member

cwhanse commented Mar 28, 2019

Is your feature request related to a problem? Please describe.
It may be easier for users to find and select IAM functions if the function names start with the prefix iam, e.g., iam_ashrae rather than the current pattern placing iam as a suffix ashraeiam

Describe the solution you'd like
Rename physicaliam, ashraeiam, etc. and deprecate old names.

@wholmgren
Copy link
Member

Related to #436... I currently prefer to see a new module iam.py with functions physical, ashrae, etc.

@cwhanse cwhanse added this to the 0.7.0 milestone Mar 29, 2019
@cwhanse
Copy link
Member Author

cwhanse commented Oct 2, 2019

Starting on a PR for this. iam.py conflicts with the often-used variable iam, e.g., iam = pvsystem.ashraeiam() in the current code. Suggestions? Seems like a good idea to keep iam available for users to name the output of these functions.

@wholmgren
Copy link
Member

I don't have a better idea, but I don't think we need to worry about what variables might exist in user code. There's only a name conflict when the module is imported as from pvlib import iam. While that's a common pattern, I don't think it's frequent enough to justify choosing a worse name for our module.

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

Successfully merging a pull request may close this issue.

2 participants