pygfunction
pygfunction copied to clipboard
Planned deprecations for v3.0
This is a list of planned deprecations for the eventual major release v3.0.
- [ ] Old g-function API functions from
v1.x. A deprecation warning was introduced in #160. - [ ]
pipes.borehole_thermal_resistance(). This function is replaced by thepipes._BasePipe.effective_borehole_thermal_resistance()class method. A deprecation warning was introduced in #148. - [ ]
boreholes.rectangle_field()and other bore field creation functions in theboreholesmodule. These functions are replaced by class methods in theborefield.Borefieldclass. A deprecation warning was introduced in #308.
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?
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.
I concur. Should the function enforce either 4 or 6 arguments? E.g. if tilt is given then orientation would be required as well.
@j-c-cook Yes. We should provide an error message on invalid files.