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

Planned deprecations for v3.0 #163

Open
3 tasks
MassimoCimmino opened this issue Nov 8, 2021 · 4 comments
Open
3 tasks

Planned deprecations for v3.0 #163

MassimoCimmino opened this issue Nov 8, 2021 · 4 comments
Milestone

Comments

@MassimoCimmino
Copy link
Owner

MassimoCimmino commented Nov 8, 2021

This is a list of planned deprecations for the eventual major release v3.0.

@j-c-cook
Copy link
Contributor

I have modified the boreholes.field_from_file(filename) function to account for tilt and orientation if they are provided in my https://github.com/j-c-cook/pygfunction/blob/issue50_FLSInclined/pygfunction/boreholes.py#L1003-L1010 branch. Should we add a deprecation warning that tilt and orientation will be a requirement in v3.0, or leave it optional?

@MassimoCimmino
Copy link
Owner Author

It may make sense to keep the last two columns optional since the tilt and orientation arguments are optional in the Borehole class. It is unlikely that these two arguments cease to be optional or that the default values change in the future.

This also cleans up the text file and eliminates the columns of zeros in fields of vertical boreholes.

@j-c-cook
Copy link
Contributor

I concur. Should the function enforce either 4 or 6 arguments? E.g. if tilt is given then orientation would be required as well.

@MassimoCimmino
Copy link
Owner Author

@j-c-cook Yes. We should provide an error message on invalid files.

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