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

Deprecate outdated g-function calculation API functions #160

Closed
MassimoCimmino opened this issue Nov 8, 2021 · 2 comments · Fixed by #165
Closed

Deprecate outdated g-function calculation API functions #160

MassimoCimmino opened this issue Nov 8, 2021 · 2 comments · Fixed by #165
Assignees
Milestone

Comments

@MassimoCimmino
Copy link
Owner

Functions gfunction.uniform_heat_extraction, gfunction.uniform_temperature, gfunction.equal_inlet_temperature and gfunction.mixed_inlet_temperature have been kept in v2.0 despite the introduction of the gFunction class.

v2.1 will introduce a new 'equivalent' solver which can't be implemented in a backwards compatible way due to the use_similarities parameter. Non-uniform discretization can still be implemented (and will be in #158).

These functions do not have any additional functionality relative to the gFunction class.

This issue is to introduce a deprecation warning in these functions pointing out the lack of support for the new solver and encouraging the user to use the gFunction class. It is proposed these functions be removed in the next major release (v3.0).

@MassimoCimmino MassimoCimmino added this to the v2.1.0 milestone Nov 8, 2021
@MassimoCimmino MassimoCimmino changed the title Deprecate g-function calculations functions Deprecate g-function calculation functions Nov 8, 2021
@j-c-cook
Copy link
Contributor

j-c-cook commented Nov 8, 2021

I think that sounds reasonable to deprecate the older function API's, and I like that you are introducing a deprecation warning. How will pygfunction track upcoming deprecations? Will a v3.0 milestone be created with a note for deprecations?

Edit: Perhaps this issue should be named "Deprecate outdated g-function calculation API functions"?

@MassimoCimmino MassimoCimmino changed the title Deprecate g-function calculation functions Deprecate outdated g-function calculation API functions Nov 8, 2021
@MassimoCimmino
Copy link
Owner Author

That is a good point. I added a milestone but it seems only issues can be tracked. I will open an issue "Planned deprecations for v3.0" where we can keep a list.

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