Skip to content

rethink module-level model parameters dictionaries #789

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
wholmgren opened this issue Oct 16, 2019 · 2 comments · Fixed by #805
Closed

rethink module-level model parameters dictionaries #789

wholmgren opened this issue Oct 16, 2019 · 2 comments · Fixed by #805
Labels
Milestone

Comments

@wholmgren
Copy link
Member

#783 is adding a iam.IAM_MODEL_PARAMS dict that's simply sets of required parameters for IAM models.

#682 added temperature.TEMPERATURE_MODEL_PARAMETERS that includes default values.

#548 added pvsystem.DC_MODEL_PARAMS that's also only sets of required parameters.

We should reconsider if we want to expose these dictionaries to users.

These dictionaries are used by methods in PVSystem and ModelChain to automagically determine what functions to call. In principle, user code might do something similar with them, but I doubt that happens.

The TEMPERATURE_MODEL_PARAMETERS dictionary with default values is probably the most useful to an end user because the default parameters are useful when calling temperature module functions directly (i.e. not through ModelChain/PVSystem).

My short term recommendation is to:

  • deprecate pvsystem.DC_MODEL_PARAMS into pvsystem._DC_MODEL_PARAMS. I'd also be ok with just changing it without deprecation because 1. 0.7 is a big release and 2. this change won't effect many people and 3. My time is limited.
  • change iam.IAM_MODEL_PARAMS to iam._IAM_MODEL_PARAMS to prevent problems before they start
  • leave TEMPERATURE_MODEL_PARAMETERS alone
@veronicaguo
Copy link
Contributor

Hi Will, I opened a short PR to make DC_MODEL_PARAMS and IAM_MODEL_PARAMS private. Please let me know what you think and if I missed anything. Thanks!

@wholmgren
Copy link
Member Author

Thanks @veronicaguo! I'm hoping that others will let us know what they think of these API choices and if the public dictionaries are actually useful to them or not...

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

Successfully merging a pull request may close this issue.

2 participants