search

modflowpy / flopy

A Python package to create, run, and post-process MODFLOW-based models.
https://flopy.readthedocs.io
Other
507 stars 307 forks source link

refactor: deprecate unused flopy.utils.binaryfile.binaryread_struct #2201

Closed mwtoews closed 3 months ago

mwtoews commented 3 months ago

This PR deprecates binaryread_struct() (documented here), since it is not used. Before FloPy migrated to GitHub, this function was replaced by binaryread() as the default method used internally due to better performance of NumPy's fromfile() over struct's unpack().

This PR also improves the docstring for binaryread(), and provides low-level testing/coverage for both methods.